// Auto-generated by scripts/generate-api-spec-index.ts - DO NOT EDIT

import type { ApiCatalogCategory, ApiCatalogCategorySummary, ApiCatalogIndex } from "./api-catalog-types";

export const API_CATALOG_INDEX: ApiCatalogIndex = {
	version: "4.0.0",
	displayName: "F5 Distributed Cloud",
	service: "f5xc",
	categoryCount: 889,
	auth: {
"type": "api_token",
      "headerName": "Authorization",
      "headerTemplate": "APIToken {token}",
      "tokenSource": "F5XC_API_TOKEN",
      "baseUrlSource": "F5XC_API_URL"
      },
	defaults: {
"namespace": {
"source": "F5XC_NAMESPACE"
}
},
};

export const API_CATALOG_CATEGORY_SUMMARIES: ReadonlyArray<ApiCatalogCategorySummary> = [
		{
"name": "access-logs",
      "displayName": "Access Logs",
      "operationCount": 1
},
		{
"name": "active-alert-policies",
"displayName": "Active Alert Policies",
"operationCount": 2
},
		{
"name": "active-network-policies",
"displayName": "Active Network Policies",
"operationCount": 2
},
		{
"name": "active-service-policies",
"displayName": "Active Service Policies",
"operationCount": 2
},
		{
"name": "active-staged-signatures",
"displayName": "Active Staged Signatures",
"operationCount": 1
},
		{
"name": "addon-services",
"displayName": "Addon Services",
"operationCount": 2
},
		{
"name": "addon-services-activation-status",
"displayName": "Addon Services Activation Status",
"operationCount": 1
},
		{
"name": "addon-services-all-activation-status",
"displayName": "Addon Services All Activation Status",
"operationCount": 1
},
		{
"name": "addon-subscribe",
"displayName": "Addon Subscribe",
"operationCount": 1
},
		{
"name": "addon-subscriptions",
"displayName": "Addon Subscriptions",
"operationCount": 5
},
		{
"name": "addon-unsubscribe",
"displayName": "Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "address-allocators",
"displayName": "Address Allocators",
"operationCount": 4
},
		{
"name": "advertise-policys",
"displayName": "Advertise Policys",
"operationCount": 5
},
		{
"name": "aggregation",
"displayName": "Aggregation",
"operationCount": 1
},
		{
"name": "ai-data-bfdp-bfdp-enable-feature",
"displayName": "Ai Data Bfdp Bfdp Enable Feature",
"operationCount": 1
},
		{
"name": "ai-data-bfdp-bfdp-gettoken",
      "displayName": "Ai Data Bfdp Bfdp Gettoken",
      "operationCount": 1
},
		{
"name": "ai-data-bfdp-bfdp-refresh-token",
      "displayName": "Ai Data Bfdp Bfdp Refresh Token",
      "operationCount": 1
},
		{
"name": "ai-data-bfdp-bfdp-subscribe",
"displayName": "Ai Data Bfdp Bfdp Subscribe",
"operationCount": 1
},
		{
"name": "ai-data-bfdp-bfdp-unsubscribe",
"displayName": "Ai Data Bfdp Bfdp Unsubscribe",
"operationCount": 1
},
		{
"name": "alert-confirm",
"displayName": "Alert Confirm",
"operationCount": 1
},
		{
"name": "alert-match",
"displayName": "Alert Match",
"operationCount": 1
},
		{
"name": "alert-policys",
"displayName": "Alert Policys",
"operationCount": 5
},
		{
"name": "alert-receivers",
"displayName": "Alert Receivers",
"operationCount": 5
},
		{
"name": "alert-test",
"displayName": "Alert Test",
"operationCount": 1
},
		{
"name": "alert-verify",
"displayName": "Alert Verify",
"operationCount": 1
},
		{
"name": "alerts",
"displayName": "Alerts",
"operationCount": 1
},
		{
"name": "all-application-inventory",
"displayName": "All Application Inventory",
"operationCount": 1
},
		{
"name": "all-application-inventory-waf-filters",
"displayName": "All Application Inventory Waf Filters",
"operationCount": 1
},
		{
"name": "all-ns-alerts",
"displayName": "All Ns Alerts",
"operationCount": 1
},
		{
"name": "allowed-tenants",
"displayName": "Allowed Tenants",
"operationCount": 5
},
		{
"name": "allowed-tenants-support-tenant-access",
      "displayName": "Allowed Tenants Support Tenant Access",
      "operationCount": 2
},
		{
"name": "api-crawlers",
      "displayName": "Api Crawlers",
      "operationCount": 5
},
		{
"name": "api-credentials",
      "displayName": "Api Credentials",
      "operationCount": 3
},
		{
"name": "api-definitions",
      "displayName": "Api Definitions",
      "operationCount": 5
},
		{
"name": "api-definitions-assign",
      "displayName": "Api Definitions Assign",
      "operationCount": 1
},
		{
"name": "api-definitions-available",
      "displayName": "Api Definitions Available",
      "operationCount": 1
},
		{
"name": "api-definitions-without-shared",
      "displayName": "Api Definitions Without Shared",
      "operationCount": 1
},
		{
"name": "api-discoverys",
      "displayName": "Api Discoverys",
      "operationCount": 5
},
		{
"name": "api-endpoint",
      "displayName": "Api Endpoint",
      "operationCount": 1
},
		{
"name": "api-endpoint-learnt-schema",
      "displayName": "Api Endpoint Learnt Schema",
      "operationCount": 2
},
		{
"name": "api-endpoint-pdf",
      "displayName": "Api Endpoint Pdf",
      "operationCount": 1
},
		{
"name": "api-endpoint-protection-suggestion",
      "displayName": "Api Endpoint Protection Suggestion",
      "operationCount": 1
},
		{
"name": "api-endpoint-sources-openapi-schema",
      "displayName": "Api Endpoint Sources Openapi Schema",
      "operationCount": 1
},
		{
"name": "api-endpoint-unmerge-sources-openapi-schema",
      "displayName": "Api Endpoint Unmerge Sources Openapi Schema",
      "operationCount": 1
},
		{
"name": "api-endpoints",
      "displayName": "Api Endpoints",
      "operationCount": 2
},
		{
"name": "api-endpoints-all-ns-stats",
      "displayName": "Api Endpoints All Ns Stats",
      "operationCount": 1
},
		{
"name": "api-endpoints-stats",
      "displayName": "Api Endpoints Stats",
      "operationCount": 1
},
		{
"name": "api-endpoints-summary-calls-by-response-code",
      "displayName": "Api Endpoints Summary Calls By Response Code",
      "operationCount": 1
},
		{
"name": "api-endpoints-summary-top-active",
      "displayName": "Api Endpoints Summary Top Active",
      "operationCount": 1
},
		{
"name": "api-endpoints-summary-top-sensitive-data",
      "displayName": "Api Endpoints Summary Top Sensitive Data",
      "operationCount": 1
},
		{
"name": "api-endpoints-swagger-spec",
      "displayName": "Api Endpoints Swagger Spec",
      "operationCount": 1
},
		{
"name": "api-group-elements",
      "displayName": "Api Group Elements",
      "operationCount": 2
},
		{
"name": "api-groups",
      "displayName": "Api Groups",
      "operationCount": 2
},
		{
"name": "api-inventory-api-endpoints-get-schema-updates",
      "displayName": "Api Inventory Api Endpoints Get Schema Updates",
      "operationCount": 1
},
		{
"name": "api-inventory-api-endpoints-update-schemas",
      "displayName": "Api Inventory Api Endpoints Update Schemas",
      "operationCount": 1
},
		{
"name": "api-testings",
      "displayName": "Api Testings",
      "operationCount": 5
},
		{
"name": "app-api-groups",
      "displayName": "App Api Groups",
      "operationCount": 5
},
		{
"name": "app-firewall-all-ns-metrics",
"displayName": "App Firewall All Ns Metrics",
"operationCount": 1
},
		{
"name": "app-firewalls",
"displayName": "App Firewalls",
"operationCount": 5
},
		{
"name": "app-security-all-ns-events",
"displayName": "App Security All Ns Events",
"operationCount": 1
},
		{
"name": "app-security-all-ns-events-aggregation",
"displayName": "App Security All Ns Events Aggregation",
"operationCount": 1
},
		{
"name": "app-security-all-ns-search-loadbalancers",
"displayName": "App Security All Ns Search Loadbalancers",
"operationCount": 1
},
		{
"name": "app-settings",
"displayName": "App Settings",
"operationCount": 5
},
		{
"name": "app-types",
"displayName": "App Types",
"operationCount": 5
},
		{
"name": "application-inventory",
"displayName": "Application Inventory",
"operationCount": 1
},
		{
"name": "application-profiless",
"displayName": "Application Profiless",
"operationCount": 5
},
		{
"name": "associated-objects",
"displayName": "Associated Objects",
"operationCount": 1
},
		{
"name": "audit-logs",
"displayName": "Audit Logs",
"operationCount": 1
},
		{
"name": "authentications",
      "displayName": "Authentications",
      "operationCount": 5
},
		{
"name": "authorization-servers",
      "displayName": "Authorization Servers",
      "operationCount": 5
},
		{
"name": "aws-tgw-sites",
"displayName": "Aws Tgw Sites",
"operationCount": 5
},
		{
"name": "aws-vpc-sites",
"displayName": "Aws Vpc Sites",
"operationCount": 5
},
		{
"name": "azure-vnet-sites",
"displayName": "Azure Vnet Sites",
"operationCount": 5
},
		{
"name": "bgp-asn-sets",
"displayName": "Bgp Asn Sets",
"operationCount": 5
},
		{
"name": "bgp-peer-status",
"displayName": "Bgp Peer Status",
"operationCount": 1
},
		{
"name": "bgp-routing-policys",
"displayName": "Bgp Routing Policys",
"operationCount": 5
},
		{
"name": "bgps",
"displayName": "Bgps",
"operationCount": 5
},
		{
"name": "bgpstatus",
"displayName": "Bgpstatus",
"operationCount": 1
},
		{
"name": "bigip-http-proxys",
"displayName": "Bigip Http Proxys",
"operationCount": 5
},
		{
"name": "bigip-virtual-servers",
"displayName": "Bigip Virtual Servers",
"operationCount": 3
},
		{
"name": "bigipconnector",
"displayName": "Bigipconnector",
"operationCount": 5
},
		{
"name": "bigipconnector-applications-discovered",
"displayName": "Bigipconnector Applications Discovered",
"operationCount": 1
},
		{
"name": "billing-usage-details",
"displayName": "Billing Usage Details",
"operationCount": 1
},
		{
"name": "billing-usage-summary",
"displayName": "Billing Usage Summary",
"operationCount": 1
},
		{
"name": "block-client-suggestion",
"displayName": "Block Client Suggestion",
"operationCount": 1
},
		{
"name": "bot-defense-app-infrastructures",
"displayName": "Bot Defense App Infrastructures",
"operationCount": 5
},
		{
"name": "bulk-revoke-api-credentials",
      "displayName": "Bulk Revoke Api Credentials",
      "operationCount": 1
},
		{
"name": "bulk-revoke-service-credentials",
      "displayName": "Bulk Revoke Service Credentials",
      "operationCount": 1
},
		{
"name": "ca-certificate",
"displayName": "Ca Certificate",
"operationCount": 1
},
		{
"name": "cascade-delete",
"displayName": "Cascade Delete",
"operationCount": 1
},
		{
"name": "catalogs",
"displayName": "Catalogs",
"operationCount": 1
},
		{
"name": "cdn-access-logs",
      "displayName": "Cdn Access Logs",
      "operationCount": 1
},
		{
"name": "cdn-access-logs-aggregation",
      "displayName": "Cdn Access Logs Aggregation",
      "operationCount": 1
},
		{
"name": "cdn-cache-purge",
"displayName": "Cdn Cache Purge",
"operationCount": 1
},
		{
"name": "cdn-cache-rules",
"displayName": "Cdn Cache Rules",
"operationCount": 5
},
		{
"name": "cdn-get-service-operation-status",
"displayName": "Cdn Get Service Operation Status",
"operationCount": 1
},
		{
"name": "cdn-lilac-cdn-addon-subscribe",
"displayName": "Cdn Lilac Cdn Addon Subscribe",
"operationCount": 1
},
		{
"name": "cdn-lilac-cdn-addon-unsubscribe",
"displayName": "Cdn Lilac Cdn Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "cdn-list-service-operations-status",
"displayName": "Cdn List Service Operations Status",
"operationCount": 1
},
		{
"name": "cdn-loadbalancers",
"displayName": "Cdn Loadbalancers",
"operationCount": 5
},
		{
"name": "cdn-metrics",
"displayName": "Cdn Metrics",
"operationCount": 1
},
		{
"name": "cdn-purge-commands",
"displayName": "Cdn Purge Commands",
"operationCount": 4
},
		{
"name": "certificate-chains",
"displayName": "Certificate Chains",
"operationCount": 5
},
		{
"name": "certificates",
"displayName": "Certificates",
"operationCount": 5
},
		{
"name": "certified-hardwares",
"displayName": "Certified Hardwares",
"operationCount": 2
},
		{
"name": "child-tenant-managers",
"displayName": "Child Tenant Managers",
"operationCount": 5
},
		{
"name": "child-tenant-support-tickets",
"displayName": "Child Tenant Support Tickets",
"operationCount": 1
},
		{
"name": "child-tenants",
"displayName": "Child Tenants",
"operationCount": 5
},
		{
"name": "close",
"displayName": "Close",
"operationCount": 1
},
		{
"name": "cloud-connects",
"displayName": "Cloud Connects",
"operationCount": 5
},
		{
"name": "cloud-connects-metrics",
"displayName": "Cloud Connects Metrics",
"operationCount": 1
},
		{
"name": "cloud-connects-segment-metrics",
"displayName": "Cloud Connects Segment Metrics",
"operationCount": 1
},
		{
"name": "cloud-credentialss",
      "displayName": "Cloud Credentialss",
      "operationCount": 5
},
		{
"name": "cloud-data-cloud-user-accounts-onboarded-networks",
"displayName": "Cloud Data Cloud User Accounts Onboarded Networks",
"operationCount": 1
},
		{
"name": "cloud-data-cloud-user-accounts-validate",
"displayName": "Cloud Data Cloud User Accounts Validate",
"operationCount": 1
},
		{
"name": "cloud-data-suggest-values",
"displayName": "Cloud Data Suggest Values",
"operationCount": 1
},
		{
"name": "cloud-elastic-ip-force-delete",
"displayName": "Cloud Elastic Ip Force Delete",
"operationCount": 1
},
		{
"name": "cloud-elastic-ips",
"displayName": "Cloud Elastic Ips",
"operationCount": 5
},
		{
"name": "cloud-links",
"displayName": "Cloud Links",
"operationCount": 5
},
		{
"name": "cloud-links-reapply-config",
"displayName": "Cloud Links Reapply Config",
"operationCount": 1
},
		{
"name": "cloud-regions",
"displayName": "Cloud Regions",
"operationCount": 3
},
		{
"name": "clusters",
"displayName": "Clusters",
"operationCount": 5
},
		{
"name": "cminstances",
"displayName": "Cminstances",
"operationCount": 5
},
		{
"name": "code-base-integrations",
"displayName": "Code Base Integrations",
"operationCount": 5
},
		{
"name": "comment",
"displayName": "Comment",
"operationCount": 1
},
		{
"name": "connectivity",
"displayName": "Connectivity",
"operationCount": 1
},
		{
"name": "connectivity-edge",
"displayName": "Connectivity Edge",
"operationCount": 1
},
		{
"name": "connectivity-node",
"displayName": "Connectivity Node",
"operationCount": 1
},
		{
"name": "contacts",
"displayName": "Contacts",
"operationCount": 5
},
		{
"name": "container-registrys",
"displayName": "Container Registrys",
"operationCount": 5
},
		{
"name": "create",
"displayName": "Create",
"operationCount": 1
},
		{
"name": "create-ticket",
"displayName": "Create Ticket",
"operationCount": 1
},
		{
"name": "crls",
"displayName": "Crls",
"operationCount": 5
},
		{
"name": "current-usage",
"displayName": "Current Usage",
"operationCount": 1
},
		{
"name": "custom",
"displayName": "Custom",
"operationCount": 4
},
		{
"name": "custom-addon-services",
"displayName": "Custom Addon Services",
"operationCount": 1
},
		{
"name": "custom-cascade-delete",
"displayName": "Custom Cascade Delete",
"operationCount": 1
},
		{
"name": "custom-countries",
"displayName": "Custom Countries",
"operationCount": 1
},
		{
"name": "custom-countries-states",
"displayName": "Custom Countries States",
"operationCount": 1
},
		{
"name": "custom-countries-states-cities",
"displayName": "Custom Countries States Cities",
"operationCount": 1
},
		{
"name": "custom-dashboards-current-layout",
"displayName": "Custom Dashboards Current Layout",
"operationCount": 1
},
		{
"name": "custom-dashboards-layouts",
"displayName": "Custom Dashboards Layouts",
"operationCount": 5
},
		{
"name": "custom-delete",
"displayName": "Custom Delete",
"operationCount": 1
},
		{
"name": "custom-idm-user-sync",
"displayName": "Custom Idm User Sync",
"operationCount": 1
},
		{
"name": "custom-list",
"displayName": "Custom List",
"operationCount": 1
},
		{
"name": "custom-mappers",
"displayName": "Custom Mappers",
"operationCount": 2
},
		{
"name": "custom-password-admin-reset",
      "displayName": "Custom Password Admin Reset",
      "operationCount": 1
},
		{
"name": "custom-password-reset",
      "displayName": "Custom Password Reset",
      "operationCount": 1
},
		{
"name": "custom-scim",
"displayName": "Custom Scim",
"operationCount": 1
},
		{
"name": "custom-user-groups",
"displayName": "Custom User Groups",
"operationCount": 5
},
		{
"name": "custom-user-groups-analyze-for-deletion",
"displayName": "Custom User Groups Analyze For Deletion",
"operationCount": 1
},
		{
"name": "custom-user-groups-assign-namespace-roles",
"displayName": "Custom User Groups Assign Namespace Roles",
"operationCount": 1
},
		{
"name": "custom-user-groups-remove-namespace-roles",
"displayName": "Custom User Groups Remove Namespace Roles",
"operationCount": 1
},
		{
"name": "custom-users-group-add",
"displayName": "Custom Users Group Add",
"operationCount": 1
},
		{
"name": "custom-users-group-remove",
"displayName": "Custom Users Group Remove",
"operationCount": 1
},
		{
"name": "customer-data",
"displayName": "Customer Data",
"operationCount": 2
},
		{
"name": "customer-support-comment-attachment",
"displayName": "Customer Support Comment Attachment",
"operationCount": 1
},
		{
"name": "customer-support-tax-exempt-request",
"displayName": "Customer Support Tax Exempt Request",
"operationCount": 1
},
		{
"name": "customer-supports",
"displayName": "Customer Supports",
"operationCount": 3
},
		{
"name": "data-exposure-suggestion",
"displayName": "Data Exposure Suggestion",
"operationCount": 1
},
		{
"name": "data-groups",
"displayName": "Data Groups",
"operationCount": 5
},
		{
"name": "data-intelligence",
"displayName": "Data Intelligence",
"operationCount": 5
},
		{
"name": "data-intelligence-data-intelligence-addon-subscribe",
"displayName": "Data Intelligence Data Intelligence Addon Subscribe",
"operationCount": 1
},
		{
"name": "data-intelligence-data-intelligence-addon-unsubscribe",
"displayName": "Data Intelligence Data Intelligence Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "data-intelligence-dataSets",
"displayName": "Data Intelligence Datasets",
"operationCount": 1
},
		{
"name": "data-intelligence-datadictionary",
"displayName": "Data Intelligence Datadictionary",
"operationCount": 1
},
		{
"name": "data-intelligence-datasets",
"displayName": "Data Intelligence Datasets",
"operationCount": 1
},
		{
"name": "data-intelligence-flowlabels",
"displayName": "Data Intelligence Flowlabels",
"operationCount": 1
},
		{
"name": "data-intelligence-init-request",
"displayName": "Data Intelligence Init Request",
"operationCount": 1
},
		{
"name": "data-intelligence-status",
"displayName": "Data Intelligence Status",
"operationCount": 1
},
		{
"name": "data-intelligence-summary",
"displayName": "Data Intelligence Summary",
"operationCount": 1
},
		{
"name": "data-intelligence-test",
"displayName": "Data Intelligence Test",
"operationCount": 1
},
		{
"name": "data-types",
"displayName": "Data Types",
"operationCount": 5
},
		{
"name": "dc-cluster-groups",
"displayName": "Dc Cluster Groups",
"operationCount": 5
},
		{
"name": "ddos-mitigation-suggestion",
"displayName": "Ddos Mitigation Suggestion",
"operationCount": 1
},
		{
"name": "delete",
"displayName": "Delete",
"operationCount": 1
},
		{
"name": "discovery",
"displayName": "Discovery",
"operationCount": 3
},
		{
"name": "discovery-create-http-load-balancer",
"displayName": "Discovery Create Http Load Balancer",
"operationCount": 1
},
		{
"name": "discovery-create-tcp-load-balancer",
"displayName": "Discovery Create Tcp Load Balancer",
"operationCount": 1
},
		{
"name": "discovery-custom",
"displayName": "Discovery Custom",
"operationCount": 1
},
		{
"name": "discovery-disable-visibility",
"displayName": "Discovery Disable Visibility",
"operationCount": 1
},
		{
"name": "discovery-enable-visibility",
"displayName": "Discovery Enable Visibility",
"operationCount": 1
},
		{
"name": "discoverys",
"displayName": "Discoverys",
"operationCount": 5
},
		{
"name": "dns",
"displayName": "Dns",
"operationCount": 5
},
		{
"name": "dns-compliance-checkss",
"displayName": "Dns Compliance Checkss",
"operationCount": 5
},
		{
"name": "dns-dns-management-addon-subscribe",
"displayName": "Dns Dns Management Addon Subscribe",
"operationCount": 1
},
		{
"name": "dns-dns-management-addon-unsubscribe",
"displayName": "Dns Dns Management Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "dns-dns-zone-clone-from-dns-domain",
"displayName": "Dns Dns Zone Clone From Dns Domain",
"operationCount": 1
},
		{
"name": "dns-dns-zone-import",
"displayName": "Dns Dns Zone Import",
"operationCount": 1
},
		{
"name": "dns-dns-zone-import-axfr",
"displayName": "Dns Dns Zone Import Axfr",
"operationCount": 1
},
		{
"name": "dns-dns-zone-import-bind-create",
"displayName": "Dns Dns Zone Import Bind Create",
"operationCount": 1
},
		{
"name": "dns-dns-zone-import-bind-validate",
"displayName": "Dns Dns Zone Import Bind Validate",
"operationCount": 1
},
		{
"name": "dns-dns-zone-initiate-zone-transfer",
"displayName": "Dns Dns Zone Initiate Zone Transfer",
"operationCount": 1
},
		{
"name": "dns-dns-zones-rrsets",
"displayName": "Dns Dns Zones Rrsets",
"operationCount": 4
},
		{
"name": "dns-domains",
"displayName": "Dns Domains",
"operationCount": 5
},
		{
"name": "dns-lb-pools-health-status",
"displayName": "Dns Lb Pools Health Status",
"operationCount": 1
},
		{
"name": "dns-lb-pools-pool-members-health-status-change-events",
"displayName": "Dns Lb Pools Pool Members Health Status Change Events",
"operationCount": 1
},
		{
"name": "dns-local-zone-file",
"displayName": "Dns Local Zone File",
"operationCount": 1
},
		{
"name": "dns-local-zone-record-names",
"displayName": "Dns Local Zone Record Names",
"operationCount": 1
},
		{
"name": "dns-proxys",
"displayName": "Dns Proxys",
"operationCount": 5
},
		{
"name": "dns-remote-zone-file",
"displayName": "Dns Remote Zone File",
"operationCount": 1
},
		{
"name": "dns-suggest-values",
"displayName": "Dns Suggest Values",
"operationCount": 1
},
		{
"name": "dns-zone-file-export",
"displayName": "Dns Zone File Export",
"operationCount": 1
},
		{
"name": "dos-automitigation-rules",
"displayName": "Dos Automitigation Rules",
"operationCount": 2
},
		{
"name": "download-certificates",
"displayName": "Download Certificates",
"operationCount": 1
},
		{
"name": "dynamic-data",
"displayName": "Dynamic Data",
"operationCount": 1
},
		{
"name": "edge-credentials",
      "displayName": "Edge Credentials",
      "operationCount": 1
},
		{
"name": "edge-list",
"displayName": "Edge List",
"operationCount": 1
},
		{
"name": "endpoints",
"displayName": "Endpoints",
"operationCount": 5
},
		{
"name": "enhanced-firewall-policys",
"displayName": "Enhanced Firewall Policys",
"operationCount": 5
},
		{
"name": "escalate",
"displayName": "Escalate",
"operationCount": 1
},
		{
"name": "evaluate",
"displayName": "Evaluate",
"operationCount": 1
},
		{
"name": "evaluate-api-access",
      "displayName": "Evaluate Api Access",
      "operationCount": 1
},
		{
"name": "evaluate-batch-api-access",
      "displayName": "Evaluate Batch Api Access",
      "operationCount": 1
},
		{
"name": "events",
"displayName": "Events",
"operationCount": 1
},
		{
"name": "events-aggregation",
"displayName": "Events Aggregation",
"operationCount": 1
},
		{
"name": "events-scroll",
"displayName": "Events Scroll",
"operationCount": 2
},
		{
"name": "external-connectors",
"displayName": "External Connectors",
"operationCount": 5
},
		{
"name": "fast-acl-rules",
"displayName": "Fast Acl Rules",
"operationCount": 5
},
		{
"name": "fast-acls",
"displayName": "Fast Acls",
"operationCount": 5
},
		{
"name": "fast-acls-for-internet-vips",
"displayName": "Fast Acls For Internet Vips",
"operationCount": 2
},
		{
"name": "filter-sets",
"displayName": "Filter Sets",
"operationCount": 5
},
		{
"name": "find",
"displayName": "Find",
"operationCount": 1
},
		{
"name": "firewall-logs",
"displayName": "Firewall Logs",
"operationCount": 1
},
		{
"name": "fleets",
"displayName": "Fleets",
"operationCount": 5
},
		{
"name": "flow-anomalys",
"displayName": "Flow Anomalys",
"operationCount": 2
},
		{
"name": "flow-collection-addon-subscribe",
"displayName": "Flow Collection Addon Subscribe",
"operationCount": 1
},
		{
"name": "flow-collection-addon-subscription-status",
"displayName": "Flow Collection Addon Subscription Status",
"operationCount": 1
},
		{
"name": "flow-collection-addon-unsubscribe",
"displayName": "Flow Collection Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "flows-flow-collection",
"displayName": "Flows Flow Collection",
"operationCount": 1
},
		{
"name": "flows-top-flow-anomalies",
"displayName": "Flows Top Flow Anomalies",
"operationCount": 1
},
		{
"name": "flows-top-talkers",
"displayName": "Flows Top Talkers",
"operationCount": 1
},
		{
"name": "forward-proxy-policys",
"displayName": "Forward Proxy Policys",
"operationCount": 5
},
		{
"name": "forwarding-classs",
"displayName": "Forwarding Classs",
"operationCount": 5
},
		{
"name": "gcp-vpc-sites",
"displayName": "Gcp Vpc Sites",
"operationCount": 5
},
		{
"name": "gen-ai",
"displayName": "Gen Ai",
"operationCount": 1
},
		{
"name": "generate-token",
      "displayName": "Generate Token",
      "operationCount": 1
},
		{
"name": "geo-configs",
"displayName": "Geo Configs",
"operationCount": 1
},
		{
"name": "get-dns-info",
"displayName": "Get Dns Info",
"operationCount": 1
},
		{
"name": "get-security-config",
"displayName": "Get Security Config",
"operationCount": 1
},
		{
"name": "gia-gia-allocateip",
"displayName": "Gia Gia Allocateip",
"operationCount": 1
},
		{
"name": "gia-gia-deallocateip",
"displayName": "Gia Gia Deallocateip",
"operationCount": 1
},
		{
"name": "global-log-receivers",
"displayName": "Global Log Receivers",
"operationCount": 5
},
		{
"name": "global-networks",
"displayName": "Global Networks",
"operationCount": 1
},
		{
"name": "graph",
"displayName": "Graph",
"operationCount": 1
},
		{
"name": "graph-all-ns-service",
"displayName": "Graph All Ns Service",
"operationCount": 1
},
		{
"name": "health-status",
"displayName": "Health Status",
"operationCount": 1
},
		{
"name": "healthchecks",
"displayName": "Healthchecks",
"operationCount": 5
},
		{
"name": "history",
"displayName": "History",
"operationCount": 1
},
		{
"name": "history-aggregation",
"displayName": "History Aggregation",
"operationCount": 1
},
		{
"name": "history-scroll",
"displayName": "History Scroll",
"operationCount": 2
},
		{
"name": "hits",
"displayName": "Hits",
"operationCount": 1
},
		{
"name": "hourly-usage-details",
"displayName": "Hourly Usage Details",
"operationCount": 1
},
		{
"name": "http-loadbalancers",
"displayName": "Http Loadbalancers",
"operationCount": 5
},
		{
"name": "ike-phase1-profiles",
"displayName": "Ike Phase1 Profiles",
"operationCount": 5
},
		{
"name": "ike-phase2-profiles",
"displayName": "Ike Phase2 Profiles",
"operationCount": 5
},
		{
"name": "ike1s",
"displayName": "Ike1S",
"operationCount": 5
},
		{
"name": "ike2s",
"displayName": "Ike2S",
"operationCount": 5
},
		{
"name": "implicit-labels",
"displayName": "Implicit Labels",
"operationCount": 1
},
		{
"name": "incidents",
"displayName": "Incidents",
"operationCount": 1
},
		{
"name": "incidents-aggregation",
"displayName": "Incidents Aggregation",
"operationCount": 1
},
		{
"name": "incidents-scroll",
"displayName": "Incidents Scroll",
"operationCount": 2
},
		{
"name": "infraprotect",
"displayName": "Infraprotect",
"operationCount": 5
},
		{
"name": "infraprotect-alert",
"displayName": "Infraprotect Alert",
"operationCount": 1
},
		{
"name": "infraprotect-alert-to-event",
"displayName": "Infraprotect Alert To Event",
"operationCount": 1
},
		{
"name": "infraprotect-alerts",
"displayName": "Infraprotect Alerts",
"operationCount": 1
},
		{
"name": "infraprotect-event",
"displayName": "Infraprotect Event",
"operationCount": 2
},
		{
"name": "infraprotect-event-alerts",
"displayName": "Infraprotect Event Alerts",
"operationCount": 1
},
		{
"name": "infraprotect-event-attachments",
"displayName": "Infraprotect Event Attachments",
"operationCount": 1
},
		{
"name": "infraprotect-event-detail",
"displayName": "Infraprotect Event Detail",
"operationCount": 2
},
		{
"name": "infraprotect-event-details",
"displayName": "Infraprotect Event Details",
"operationCount": 2
},
		{
"name": "infraprotect-event-mitigation-annotations",
"displayName": "Infraprotect Event Mitigation Annotations",
"operationCount": 1
},
		{
"name": "infraprotect-events",
"displayName": "Infraprotect Events",
"operationCount": 1
},
		{
"name": "infraprotect-events-summary",
"displayName": "Infraprotect Events Summary",
"operationCount": 1
},
		{
"name": "infraprotect-infraprotect-access",
      "displayName": "Infraprotect Infraprotect Access",
      "operationCount": 1
},
		{
"name": "infraprotect-l3l4-by-application",
"displayName": "Infraprotect L3L4 By Application",
"operationCount": 1
},
		{
"name": "infraprotect-l3l4-by-mitigation",
"displayName": "Infraprotect L3L4 By Mitigation",
"operationCount": 1
},
		{
"name": "infraprotect-l3l4-by-network",
"displayName": "Infraprotect L3L4 By Network",
"operationCount": 1
},
		{
"name": "infraprotect-l3l4-by-zone",
"displayName": "Infraprotect L3L4 By Zone",
"operationCount": 1
},
		{
"name": "infraprotect-l3l4-event-count",
"displayName": "Infraprotect L3L4 Event Count",
"operationCount": 1
},
		{
"name": "infraprotect-l3l4-top-talkers",
"displayName": "Infraprotect L3L4 Top Talkers",
"operationCount": 1
},
		{
"name": "infraprotect-mitigation",
"displayName": "Infraprotect Mitigation",
"operationCount": 1
},
		{
"name": "infraprotect-mitigation-annotations",
"displayName": "Infraprotect Mitigation Annotations",
"operationCount": 1
},
		{
"name": "infraprotect-mitigation-countermeasures",
"displayName": "Infraprotect Mitigation Countermeasures",
"operationCount": 1
},
		{
"name": "infraprotect-mitigation-ips",
"displayName": "Infraprotect Mitigation Ips",
"operationCount": 1
},
		{
"name": "infraprotect-mitigations",
"displayName": "Infraprotect Mitigations",
"operationCount": 1
},
		{
"name": "infraprotect-networks",
"displayName": "Infraprotect Networks",
"operationCount": 1
},
		{
"name": "infraprotect-report",
"displayName": "Infraprotect Report",
"operationCount": 1
},
		{
"name": "infraprotect-reports",
"displayName": "Infraprotect Reports",
"operationCount": 1
},
		{
"name": "infraprotect-update-advertisement-status",
"displayName": "Infraprotect Update Advertisement Status",
"operationCount": 1
},
		{
"name": "infraprotect-update-asn-prefix-irr-override",
"displayName": "Infraprotect Update Asn Prefix Irr Override",
"operationCount": 1
},
		{
"name": "infraprotect-update-asn-prefix-review-status",
"displayName": "Infraprotect Update Asn Prefix Review Status",
"operationCount": 1
},
		{
"name": "infraprotect-update-asn-review-status",
"displayName": "Infraprotect Update Asn Review Status",
"operationCount": 1
},
		{
"name": "infraprotect-update-tunnel-clear-df-bit",
"displayName": "Infraprotect Update Tunnel Clear Df Bit",
"operationCount": 1
},
		{
"name": "infraprotect-update-tunnel-status",
"displayName": "Infraprotect Update Tunnel Status",
"operationCount": 1
},
		{
"name": "interface",
"displayName": "Interface",
"operationCount": 1
},
		{
"name": "invoice-pdf",
"displayName": "Invoice Pdf",
"operationCount": 1
},
		{
"name": "invoices-custom-list",
"displayName": "Invoices Custom List",
"operationCount": 1
},
		{
"name": "ip-prefix-sets",
"displayName": "Ip Prefix Sets",
"operationCount": 5
},
		{
"name": "irules",
"displayName": "Irules",
"operationCount": 5
},
		{
"name": "k8s-audit-logs",
"displayName": "K8S Audit Logs",
"operationCount": 1
},
		{
"name": "k8s-audit-logs-aggregation",
"displayName": "K8S Audit Logs Aggregation",
"operationCount": 1
},
		{
"name": "k8s-cluster-role-bindings",
"displayName": "K8S Cluster Role Bindings",
"operationCount": 5
},
		{
"name": "k8s-cluster-roles",
"displayName": "K8S Cluster Roles",
"operationCount": 5
},
		{
"name": "k8s-clusters",
"displayName": "K8S Clusters",
"operationCount": 5
},
		{
"name": "k8s-events",
"displayName": "K8S Events",
"operationCount": 1
},
		{
"name": "k8s-events-aggregation",
"displayName": "K8S Events Aggregation",
"operationCount": 1
},
		{
"name": "k8s-pod-security-admissions",
"displayName": "K8S Pod Security Admissions",
"operationCount": 5
},
		{
"name": "k8s-pod-security-policys",
"displayName": "K8S Pod Security Policys",
"operationCount": 5
},
		{
"name": "known-label-keys",
      "displayName": "Known Label Keys",
      "operationCount": 1
},
		{
"name": "known-labels",
"displayName": "Known Labels",
"operationCount": 1
},
		{
"name": "l7ddos-rps-threshold",
"displayName": "L7Ddos Rps Threshold",
"operationCount": 1
},
		{
"name": "latency",
"displayName": "Latency",
"operationCount": 1
},
		{
"name": "lb-cache-content",
"displayName": "Lb Cache Content",
"operationCount": 1
},
		{
"name": "limits",
"displayName": "Limits",
"operationCount": 1
},
		{
"name": "lma-regions",
"displayName": "Lma Regions",
"operationCount": 2
},
		{
"name": "loadbalancers",
"displayName": "Loadbalancers",
"operationCount": 1
},
		{
"name": "local-kubeconfig",
"displayName": "Local Kubeconfig",
"operationCount": 1
},
		{
"name": "local-kubeconfigs",
"displayName": "Local Kubeconfigs",
"operationCount": 1
},
		{
"name": "log-receiver-test",
"displayName": "Log Receiver Test",
"operationCount": 1
},
		{
"name": "log-receivers",
"displayName": "Log Receivers",
"operationCount": 5
},
		{
"name": "lookup-user-roles",
"displayName": "Lookup User Roles",
"operationCount": 1
},
		{
"name": "malicious-user-mitigations",
"displayName": "Malicious User Mitigations",
"operationCount": 5
},
		{
"name": "malware-protection-addon-subscribe",
"displayName": "Malware Protection Addon Subscribe",
"operationCount": 1
},
		{
"name": "malware-protection-addon-unsubscribe",
"displayName": "Malware Protection Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "managed-client-customer-supports",
"displayName": "Managed Client Customer Supports",
"operationCount": 3
},
		{
"name": "managed-client-customer-supports-close",
"displayName": "Managed Client Customer Supports Close",
"operationCount": 1
},
		{
"name": "managed-client-customer-supports-comment",
"displayName": "Managed Client Customer Supports Comment",
"operationCount": 1
},
		{
"name": "managed-client-customer-supports-comment-attachment",
"displayName": "Managed Client Customer Supports Comment Attachment",
"operationCount": 1
},
		{
"name": "managed-client-customer-supports-escalate",
"displayName": "Managed Client Customer Supports Escalate",
"operationCount": 1
},
		{
"name": "managed-client-customer-supports-priority",
"displayName": "Managed Client Customer Supports Priority",
"operationCount": 1
},
		{
"name": "managed-client-customer-supports-reopen",
"displayName": "Managed Client Customer Supports Reopen",
"operationCount": 1
},
		{
"name": "managed-tenants",
"displayName": "Managed Tenants",
"operationCount": 5
},
		{
"name": "managed-tenants-by-user",
"displayName": "Managed Tenants By User",
"operationCount": 1
},
		{
"name": "managed-tenants-list",
"displayName": "Managed Tenants List",
"operationCount": 1
},
		{
"name": "mark-as-non-api",
      "displayName": "Mark As Non Api",
      "operationCount": 1
},
		{
"name": "maurice-pre-upgrade-check",
"displayName": "Maurice Pre Upgrade Check",
"operationCount": 1
},
		{
"name": "maurice-software-os-version",
"displayName": "Maurice Software Os Version",
"operationCount": 1
},
		{
"name": "maurice-upgradable-sw-versions",
"displayName": "Maurice Upgradable Sw Versions",
"operationCount": 1
},
		{
"name": "maurice-upgrade-status",
"displayName": "Maurice Upgrade Status",
"operationCount": 1
},
		{
"name": "metrics",
"displayName": "Metrics",
"operationCount": 1
},
		{
"name": "metrics-client-rule-hits",
"displayName": "Metrics Client Rule Hits",
"operationCount": 1
},
		{
"name": "metrics-client-security-events",
"displayName": "Metrics Client Security Events",
"operationCount": 1
},
		{
"name": "metrics-server-rule-hits",
"displayName": "Metrics Server Rule Hits",
"operationCount": 1
},
		{
"name": "metrics-server-security-events",
"displayName": "Metrics Server Security Events",
"operationCount": 1
},
		{
"name": "mobile-app-shield-mobile-app-shield-addon-subscribe",
"displayName": "Mobile App Shield Mobile App Shield Addon Subscribe",
"operationCount": 1
},
		{
"name": "mobile-app-shield-mobile-app-shield-addon-unsubscribe",
"displayName": "Mobile App Shield Mobile App Shield Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "mobile-integrator-mobile-integrator-addon-subscribe",
"displayName": "Mobile Integrator Mobile Integrator Addon Subscribe",
"operationCount": 1
},
		{
"name": "mobile-integrator-mobile-integrator-addon-unsubscribe",
"displayName": "Mobile Integrator Mobile Integrator Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "mobile-security",
"displayName": "Mobile Security",
"operationCount": 5
},
		{
"name": "monthly-usage",
"displayName": "Monthly Usage",
"operationCount": 1
},
		{
"name": "move-to-inventory",
"displayName": "Move To Inventory",
"operationCount": 1
},
		{
"name": "namespace-roles",
"displayName": "Namespace Roles",
"operationCount": 2
},
		{
"name": "namespaces",
"displayName": "Namespaces",
"operationCount": 4
},
		{
"name": "nat-policys",
"displayName": "Nat Policys",
"operationCount": 5
},
		{
"name": "navigation-tiles",
"displayName": "Navigation Tiles",
"operationCount": 2
},
		{
"name": "network-connectors",
"displayName": "Network Connectors",
"operationCount": 5
},
		{
"name": "network-firewalls",
"displayName": "Network Firewalls",
"operationCount": 5
},
		{
"name": "network-interfaces",
"displayName": "Network Interfaces",
"operationCount": 5
},
		{
"name": "network-policy-rules",
"displayName": "Network Policy Rules",
"operationCount": 5
},
		{
"name": "network-policy-sets",
"displayName": "Network Policy Sets",
"operationCount": 2
},
		{
"name": "network-policy-views",
"displayName": "Network Policy Views",
"operationCount": 5
},
		{
"name": "network-policys",
"displayName": "Network Policys",
"operationCount": 5
},
		{
"name": "networking-inventory",
"displayName": "Networking Inventory",
"operationCount": 1
},
		{
"name": "nfv-service-force-delete",
"displayName": "Nfv Service Force Delete",
"operationCount": 1
},
		{
"name": "nfv-services",
"displayName": "Nfv Services",
"operationCount": 5
},
		{
"name": "nginx-csgs",
"displayName": "Nginx Csgs",
"operationCount": 2
},
		{
"name": "nginx-dataplane-servers",
"displayName": "Nginx Dataplane Servers",
"operationCount": 1
},
		{
"name": "nginx-instances",
"displayName": "Nginx Instances",
"operationCount": 2
},
		{
"name": "nginx-one-n1-subscribe",
"displayName": "Nginx One N1 Subscribe",
"operationCount": 1
},
		{
"name": "nginx-one-n1-unsubscribe",
"displayName": "Nginx One N1 Unsubscribe",
"operationCount": 1
},
		{
"name": "nginx-servers",
"displayName": "Nginx Servers",
"operationCount": 2
},
		{
"name": "nginx-service-discoverys",
"displayName": "Nginx Service Discoverys",
"operationCount": 5
},
		{
"name": "no-auth-aws-f5xc-saas-register",
      "displayName": "No Auth Aws F5Xc Saas Register",
      "operationCount": 1
},
		{
"name": "no-auth-aws-f5xc-saas-signup",
      "displayName": "No Auth Aws F5Xc Saas Signup",
      "operationCount": 1
},
		{
"name": "no-auth-billing-plan-transition",
      "displayName": "No Auth Billing Plan Transition",
      "operationCount": 1
},
		{
"name": "no-auth-cname-lookup",
      "displayName": "No Auth Cname Lookup",
      "operationCount": 1
},
		{
"name": "no-auth-countries",
      "displayName": "No Auth Countries",
      "operationCount": 1
},
		{
"name": "no-auth-countries-states",
      "displayName": "No Auth Countries States",
      "operationCount": 1
},
		{
"name": "no-auth-countries-states-cities",
      "displayName": "No Auth Countries States Cities",
      "operationCount": 1
},
		{
"name": "no-auth-f5xc-saas-signup",
      "displayName": "No Auth F5Xc Saas Signup",
      "operationCount": 1
},
		{
"name": "no-auth-f5xc-saas-signup-registration-details",
      "displayName": "No Auth F5Xc Saas Signup Registration Details",
      "operationCount": 1
},
		{
"name": "no-auth-f5xc-saas-signup-send-email",
      "displayName": "No Auth F5Xc Saas Signup Send Email",
      "operationCount": 1
},
		{
"name": "no-auth-login-validate-registration",
      "displayName": "No Auth Login Validate Registration",
      "operationCount": 1
},
		{
"name": "no-auth-send-password-email",
      "displayName": "No Auth Send Password Email",
      "operationCount": 1
},
		{
"name": "no-auth-signup",
      "displayName": "No Auth Signup",
      "operationCount": 1
},
		{
"name": "no-auth-tenant-idm-settings-password-policy",
      "displayName": "No Auth Tenant Idm Settings Password Policy",
      "operationCount": 1
},
		{
"name": "no-auth-validate-contact",
      "displayName": "No Auth Validate Contact",
      "operationCount": 1
},
		{
"name": "oas-validation-suggestion",
"displayName": "Oas Validation Suggestion",
"operationCount": 1
},
		{
"name": "object-store",
"displayName": "Object Store",
"operationCount": 3
},
		{
"name": "object-store-mobile-app-shield",
"displayName": "Object Store Mobile App Shield",
"operationCount": 2
},
		{
"name": "object-store-mobile-integrator",
"displayName": "Object Store Mobile Integrator",
"operationCount": 2
},
		{
"name": "object-store-mobile-sdk",
"displayName": "Object Store Mobile Sdk",
"operationCount": 2
},
		{
"name": "object-store-mobile-sdk-self-serve",
"displayName": "Object Store Mobile Sdk Self Serve",
"operationCount": 2
},
		{
"name": "observability-connector-observability-subscribe",
"displayName": "Observability Connector Observability Subscribe",
"operationCount": 1
},
		{
"name": "observability-connector-observability-unsubscribe",
"displayName": "Observability Connector Observability Unsubscribe",
"operationCount": 1
},
		{
"name": "observability-synthetic-monitor",
"displayName": "Observability Synthetic Monitor",
"operationCount": 5
},
		{
"name": "operate-sites-vpm-debug-change-password",
      "displayName": "Operate Sites Vpm Debug Change Password",
      "operationCount": 1
},
		{
"name": "operate-sites-vpm-debug-global-allow-f5-ssh",
"displayName": "Operate Sites Vpm Debug Global Allow F5 Ssh",
"operationCount": 1
},
		{
"name": "operate-sites-vpm-debug-global-check-debug-info-collection",
"displayName": "Operate Sites Vpm Debug Global Check Debug Info Collection",
"operationCount": 1
},
		{
"name": "operate-sites-vpm-debug-global-diagnosis",
"displayName": "Operate Sites Vpm Debug Global Diagnosis",
"operationCount": 1
},
		{
"name": "operate-sites-vpm-debug-global-download-debug-info-collection",
"displayName": "Operate Sites Vpm Debug Global Download Debug Info Collection",
"operationCount": 1
},
		{
"name": "operate-sites-vpm-debug-global-health",
"displayName": "Operate Sites Vpm Debug Global Health",
"operationCount": 1
},
		{
"name": "operate-sites-vpm-debug-start-debug-info-collection",
"displayName": "Operate Sites Vpm Debug Start Debug Info Collection",
"operationCount": 1
},
		{
"name": "operate-ver-bgp-peers",
"displayName": "Operate Ver Bgp Peers",
"operationCount": 1
},
		{
"name": "operate-ver-bgp-routes",
"displayName": "Operate Ver Bgp Routes",
"operationCount": 1
},
		{
"name": "operate-ver-dhcp-leases",
"displayName": "Operate Ver Dhcp Leases",
"operationCount": 1
},
		{
"name": "operate-ver-fetchdump",
"displayName": "Operate Ver Fetchdump",
"operationCount": 1
},
		{
"name": "operate-ver-list-tcpdump",
"displayName": "Operate Ver List Tcpdump",
"operationCount": 1
},
		{
"name": "operate-ver-matching-flows",
"displayName": "Operate Ver Matching Flows",
"operationCount": 1
},
		{
"name": "operate-ver-ping",
"displayName": "Operate Ver Ping",
"operationCount": 1
},
		{
"name": "operate-ver-resync-crl",
"displayName": "Operate Ver Resync Crl",
"operationCount": 1
},
		{
"name": "operate-ver-routes",
"displayName": "Operate Ver Routes",
"operationCount": 1
},
		{
"name": "operate-ver-simplified-routes",
"displayName": "Operate Ver Simplified Routes",
"operationCount": 1
},
		{
"name": "operate-ver-stop-tcpdump",
"displayName": "Operate Ver Stop Tcpdump",
"operationCount": 1
},
		{
"name": "operate-ver-tcpdump",
"displayName": "Operate Ver Tcpdump",
"operationCount": 1
},
		{
"name": "operate-ver-traceroute",
"displayName": "Operate Ver Traceroute",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-exec",
"displayName": "Operate Vpm Debug Exec",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-exec-log",
"displayName": "Operate Vpm Debug Exec Log",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-exec-user",
"displayName": "Operate Vpm Debug Exec User",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-global-list-service",
"displayName": "Operate Vpm Debug Global List Service",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-global-status",
"displayName": "Operate Vpm Debug Global Status",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-host-ping",
"displayName": "Operate Vpm Debug Host Ping",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-log",
"displayName": "Operate Vpm Debug Log",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-reboot",
"displayName": "Operate Vpm Debug Reboot",
"operationCount": 1
},
		{
"name": "operate-vpm-debug-soft-restart",
"displayName": "Operate Vpm Debug Soft Restart",
"operationCount": 1
},
		{
"name": "operate-vpm-lte",
"displayName": "Operate Vpm Lte",
"operationCount": 2
},
		{
"name": "operate-vpm-lte-disconnect",
"displayName": "Operate Vpm Lte Disconnect",
"operationCount": 1
},
		{
"name": "operate-vpm-lte-info",
"displayName": "Operate Vpm Lte Info",
"operationCount": 1
},
		{
"name": "operate-vpm-usb",
"displayName": "Operate Vpm Usb",
"operationCount": 2
},
		{
"name": "operate-vpm-usb-list",
"displayName": "Operate Vpm Usb List",
"operationCount": 1
},
		{
"name": "operate-vpm-usb-rules",
"displayName": "Operate Vpm Usb Rules",
"operationCount": 1
},
		{
"name": "operate-vpm-usb-rules-add",
"displayName": "Operate Vpm Usb Rules Add",
"operationCount": 1
},
		{
"name": "operate-vpm-usb-rules-delete",
"displayName": "Operate Vpm Usb Rules Delete",
"operationCount": 1
},
		{
"name": "operate-vpm-wifi",
"displayName": "Operate Vpm Wifi",
"operationCount": 2
},
		{
"name": "operate-vpm-wifi-disconnect",
"displayName": "Operate Vpm Wifi Disconnect",
"operationCount": 1
},
		{
"name": "operate-vpm-wifi-info",
"displayName": "Operate Vpm Wifi Info",
"operationCount": 1
},
		{
"name": "operate-vpm-wifi-list",
"displayName": "Operate Vpm Wifi List",
"operationCount": 1
},
		{
"name": "origin-pools",
"displayName": "Origin Pools",
"operationCount": 5
},
		{
"name": "override-pop",
"displayName": "Override Pop",
"operationCount": 1
},
		{
"name": "override-push",
"displayName": "Override Push",
"operationCount": 1
},
		{
"name": "overrides",
"displayName": "Overrides",
"operationCount": 1
},
		{
"name": "partner-management-child-tenant-managers-child-tenants",
"displayName": "Partner Management Child Tenant Managers Child Tenants",
"operationCount": 1
},
		{
"name": "partner-management-child-tenant-managers-child-tenants-migrate",
"displayName": "Partner Management Child Tenant Managers Child Tenants Migrate",
"operationCount": 1
},
		{
"name": "partner-management-child-tenants",
"displayName": "Partner Management Child Tenants",
"operationCount": 1
},
		{
"name": "partner-management-child-tenants-migrate",
"displayName": "Partner Management Child Tenants Migrate",
"operationCount": 1
},
		{
"name": "partner-management-customer-supports",
"displayName": "Partner Management Customer Supports",
"operationCount": 3
},
		{
"name": "partner-management-customer-supports-close",
"displayName": "Partner Management Customer Supports Close",
"operationCount": 1
},
		{
"name": "partner-management-customer-supports-comment",
"displayName": "Partner Management Customer Supports Comment",
"operationCount": 1
},
		{
"name": "partner-management-customer-supports-comment-attachment",
"displayName": "Partner Management Customer Supports Comment Attachment",
"operationCount": 1
},
		{
"name": "partner-management-customer-supports-escalate",
"displayName": "Partner Management Customer Supports Escalate",
"operationCount": 1
},
		{
"name": "partner-management-customer-supports-priority",
"displayName": "Partner Management Customer Supports Priority",
"operationCount": 1
},
		{
"name": "partner-management-customer-supports-reopen",
"displayName": "Partner Management Customer Supports Reopen",
"operationCount": 1
},
		{
"name": "payment-method-primary",
"displayName": "Payment Method Primary",
"operationCount": 1
},
		{
"name": "payment-method-secondary",
"displayName": "Payment Method Secondary",
"operationCount": 1
},
		{
"name": "payment-method-swap-primary",
"displayName": "Payment Method Swap Primary",
"operationCount": 1
},
		{
"name": "payment-methods",
"displayName": "Payment Methods",
"operationCount": 2
},
		{
"name": "plan-transition",
"displayName": "Plan Transition",
"operationCount": 1
},
		{
"name": "plans",
"displayName": "Plans",
"operationCount": 2
},
		{
"name": "platform-events",
"displayName": "Platform Events",
"operationCount": 1
},
		{
"name": "policers",
"displayName": "Policers",
"operationCount": 5
},
		{
"name": "policy-based-routings",
"displayName": "Policy Based Routings",
"operationCount": 5
},
		{
"name": "pool-members-health-status",
"displayName": "Pool Members Health Status",
"operationCount": 1
},
		{
"name": "priority",
"displayName": "Priority",
"operationCount": 1
},
		{
"name": "protocol-inspections",
"displayName": "Protocol Inspections",
"operationCount": 5
},
		{
"name": "protocol-policers",
"displayName": "Protocol Policers",
"operationCount": 5
},
		{
"name": "proxys",
"displayName": "Proxys",
"operationCount": 5
},
		{
"name": "public-ips",
"displayName": "Public Ips",
"operationCount": 3
},
		{
"name": "pvc-metrics",
"displayName": "Pvc Metrics",
"operationCount": 1
},
		{
"name": "quotas",
"displayName": "Quotas",
"operationCount": 5
},
		{
"name": "rate-limit-suggestion",
"displayName": "Rate Limit Suggestion",
"operationCount": 1
},
		{
"name": "rate-limiter-policys",
"displayName": "Rate Limiter Policys",
"operationCount": 5
},
		{
"name": "rate-limiters",
"displayName": "Rate Limiters",
"operationCount": 5
},
		{
"name": "rbac-policys",
"displayName": "Rbac Policys",
"operationCount": 2
},
		{
"name": "register",
"displayName": "Register",
"operationCount": 5
},
		{
"name": "register-approve",
"displayName": "Register Approve",
"operationCount": 1
},
		{
"name": "register-get-cloud-init-config",
"displayName": "Register Get Cloud Init Config",
"operationCount": 1
},
		{
"name": "register-get-image-download-url",
"displayName": "Register Get Image Download Url",
"operationCount": 1
},
		{
"name": "register-get-registrations-by-token",
      "displayName": "Register Get Registrations By Token",
      "operationCount": 1
},
		{
"name": "register-registerBootstrap",
"displayName": "Register Registerbootstrap",
"operationCount": 1
},
		{
"name": "register-requestConfig",
"displayName": "Register Requestconfig",
"operationCount": 1
},
		{
"name": "register-state",
"displayName": "Register State",
"operationCount": 1
},
		{
"name": "register-suggest-values",
"displayName": "Register Suggest Values",
"operationCount": 1
},
		{
"name": "released-signatures",
"displayName": "Released Signatures",
"operationCount": 1
},
		{
"name": "remove-from-inventory",
"displayName": "Remove From Inventory",
"operationCount": 1
},
		{
"name": "reopen",
"displayName": "Reopen",
"operationCount": 1
},
		{
"name": "report",
"displayName": "Report",
"operationCount": 5
},
		{
"name": "report-download",
"displayName": "Report Download",
"operationCount": 1
},
		{
"name": "report-generate",
"displayName": "Report Generate",
"operationCount": 1
},
		{
"name": "report-list-reports-history",
"displayName": "Report List Reports History",
"operationCount": 1
},
		{
"name": "report-list-reports-history-bot-defence",
"displayName": "Report List Reports History Bot Defence",
"operationCount": 1
},
		{
"name": "report-list-reports-history-waap",
"displayName": "Report List Reports History Waap",
"operationCount": 1
},
		{
"name": "request-logs",
"displayName": "Request Logs",
"operationCount": 1
},
		{
"name": "revoke-global-kubeconfigs",
"displayName": "Revoke Global Kubeconfigs",
"operationCount": 1
},
		{
"name": "roles",
"displayName": "Roles",
"operationCount": 5
},
		{
"name": "routes",
"displayName": "Routes",
"operationCount": 5
},
		{
"name": "rtip-internal",
"displayName": "Rtip Internal",
"operationCount": 2
},
		{
"name": "rule-suggestion-api-endpoint-protection",
      "displayName": "Rule Suggestion Api Endpoint Protection",
      "operationCount": 1
},
		{
"name": "rule-suggestion-data-exposure",
"displayName": "Rule Suggestion Data Exposure",
"operationCount": 1
},
		{
"name": "rule-suggestion-oas-validation",
"displayName": "Rule Suggestion Oas Validation",
"operationCount": 1
},
		{
"name": "rule-suggestion-rate-limit",
"displayName": "Rule Suggestion Rate Limit",
"operationCount": 1
},
		{
"name": "saas-v2-tenant-deactivate",
"displayName": "Saas V2 Tenant Deactivate",
"operationCount": 1
},
		{
"name": "schemas-.*",
"displayName": "Schemas .*",
"operationCount": 1
},
		{
"name": "scim-token",
      "displayName": "Scim Token",
      "operationCount": 2
},
		{
"name": "scim-v2-Groups",
"displayName": "Scim V2 Groups",
"operationCount": 6
},
		{
"name": "scim-v2-ResourceTypes",
"displayName": "Scim V2 Resourcetypes",
"operationCount": 2
},
		{
"name": "scim-v2-Schemas",
"displayName": "Scim V2 Schemas",
"operationCount": 2
},
		{
"name": "scim-v2-ServiceProviderConfig",
"displayName": "Scim V2 Serviceproviderconfig",
"operationCount": 1
},
		{
"name": "scim-v2-Users",
"displayName": "Scim V2 Users",
"operationCount": 6
},
		{
"name": "scroll",
"displayName": "Scroll",
"operationCount": 2
},
		{
"name": "search-loadbalancers",
"displayName": "Search Loadbalancers",
"operationCount": 1
},
		{
"name": "secret-management",
      "displayName": "Secret Management",
      "operationCount": 5
},
		{
"name": "secret-management-access-count",
      "displayName": "Secret Management Access Count",
      "operationCount": 1
},
		{
"name": "secret-management-accesss",
      "displayName": "Secret Management Accesss",
      "operationCount": 5
},
		{
"name": "secret-management-audit-logs",
      "displayName": "Secret Management Audit Logs",
      "operationCount": 1
},
		{
"name": "secret-management-audit-logs-aggregation",
      "displayName": "Secret Management Audit Logs Aggregation",
      "operationCount": 1
},
		{
"name": "secret-management-audit-logs-scroll",
      "displayName": "Secret Management Audit Logs Scroll",
      "operationCount": 2
},
		{
"name": "secret-management-get-policy-document",
      "displayName": "Secret Management Get Policy Document",
      "operationCount": 1
},
		{
"name": "secret-management-get-public-key",
      "displayName": "Secret Management Get Public Key",
      "operationCount": 1
},
		{
"name": "secret-management-list-policy",
      "displayName": "Secret Management List Policy",
      "operationCount": 1
},
		{
"name": "secret-management-recover",
      "displayName": "Secret Management Recover",
      "operationCount": 1
},
		{
"name": "secret-management-softdelete",
      "displayName": "Secret Management Softdelete",
      "operationCount": 1
},
		{
"name": "secret-management-voltshare-decrypt-secret",
      "displayName": "Secret Management Voltshare Decrypt Secret",
      "operationCount": 1
},
		{
"name": "secret-management-voltshare-process-policy-information",
      "displayName": "Secret Management Voltshare Process Policy Information",
      "operationCount": 1
},
		{
"name": "securemesh-site-v2s",
"displayName": "Securemesh Site V2S",
"operationCount": 5
},
		{
"name": "securemesh-sites",
"displayName": "Securemesh Sites",
"operationCount": 5
},
		{
"name": "segment-connections",
"displayName": "Segment Connections",
"operationCount": 3
},
		{
"name": "segments",
"displayName": "Segments",
"operationCount": 5
},
		{
"name": "selectees",
"displayName": "Selectees",
"operationCount": 1
},
		{
"name": "sensitive-data-policys",
"displayName": "Sensitive Data Policys",
"operationCount": 5
},
		{
"name": "service",
"displayName": "Service",
"operationCount": 1
},
		{
"name": "service-app-types",
"displayName": "Service App Types",
"operationCount": 1
},
		{
"name": "service-credentials",
      "displayName": "Service Credentials",
      "operationCount": 4
},
		{
"name": "service-edge",
"displayName": "Service Edge",
"operationCount": 1
},
		{
"name": "service-node",
"displayName": "Service Node",
"operationCount": 1
},
		{
"name": "service-node-instance",
"displayName": "Service Node Instance",
"operationCount": 1
},
		{
"name": "service-node-instances",
"displayName": "Service Node Instances",
"operationCount": 1
},
		{
"name": "service-policy-rules",
"displayName": "Service Policy Rules",
"operationCount": 5
},
		{
"name": "service-policy-sets",
"displayName": "Service Policy Sets",
"operationCount": 2
},
		{
"name": "service-policys",
"displayName": "Service Policys",
"operationCount": 5
},
		{
"name": "services-api-endpoint-pdf",
      "displayName": "Services Api Endpoint Pdf",
      "operationCount": 1
},
		{
"name": "services-api-endpoints",
      "displayName": "Services Api Endpoints",
      "operationCount": 1
},
		{
"name": "set-cloud-site-info",
"displayName": "Set Cloud Site Info",
"operationCount": 1
},
		{
"name": "set-log-anonymization",
"displayName": "Set Log Anonymization",
"operationCount": 1
},
		{
"name": "set-tgw-info",
"displayName": "Set Tgw Info",
"operationCount": 1
},
		{
"name": "set-vip-info",
"displayName": "Set Vip Info",
"operationCount": 1
},
		{
"name": "set-vpc-ip-prefixes",
"displayName": "Set Vpc Ip Prefixes",
"operationCount": 1
},
		{
"name": "set-vpn-tunnels",
"displayName": "Set Vpn Tunnels",
"operationCount": 1
},
		{
"name": "settings",
"displayName": "Settings",
"operationCount": 1
},
		{
"name": "shape-alerts",
"displayName": "Shape Alerts",
"operationCount": 5
},
		{
"name": "shape-alerts-clone",
"displayName": "Shape Alerts Clone",
"operationCount": 1
},
		{
"name": "shape-alerts-status",
"displayName": "Shape Alerts Status",
"operationCount": 1
},
		{
"name": "shape-bot",
"displayName": "Shape Bot",
"operationCount": 5
},
		{
"name": "shape-bot-add-to-csr",
"displayName": "Shape Bot Add To Csr",
"operationCount": 1
},
		{
"name": "shape-bot-add-with-private-key",
      "displayName": "Shape Bot Add With Private Key",
      "operationCount": 1
},
		{
"name": "shape-bot-apikey",
      "displayName": "Shape Bot Apikey",
      "operationCount": 1
},
		{
"name": "shape-bot-apply-certificate",
"displayName": "Shape Bot Apply Certificate",
"operationCount": 1
},
		{
"name": "shape-bot-archive",
"displayName": "Shape Bot Archive",
"operationCount": 1
},
		{
"name": "shape-bot-atb",
"displayName": "Shape Bot Atb",
"operationCount": 2
},
		{
"name": "shape-bot-bot-defense-addon-subscribe",
"displayName": "Shape Bot Bot Defense Addon Subscribe",
"operationCount": 1
},
		{
"name": "shape-bot-bot-defense-addon-unsubscribe",
"displayName": "Shape Bot Bot Defense Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "shape-bot-consumption-summary",
"displayName": "Shape Bot Consumption Summary",
"operationCount": 1
},
		{
"name": "shape-bot-csr",
"displayName": "Shape Bot Csr",
"operationCount": 2
},
		{
"name": "shape-bot-custom",
"displayName": "Shape Bot Custom",
"operationCount": 3
},
		{
"name": "shape-bot-custom-deployments",
"displayName": "Shape Bot Custom Deployments",
"operationCount": 2
},
		{
"name": "shape-bot-custom-draft",
"displayName": "Shape Bot Custom Draft",
"operationCount": 3
},
		{
"name": "shape-bot-custom-summary",
"displayName": "Shape Bot Custom Summary",
"operationCount": 1
},
		{
"name": "shape-bot-defense-instances",
"displayName": "Shape Bot Defense Instances",
"operationCount": 2
},
		{
"name": "shape-bot-deployment-history",
"displayName": "Shape Bot Deployment History",
"operationCount": 1
},
		{
"name": "shape-bot-deployment-status",
"displayName": "Shape Bot Deployment Status",
"operationCount": 1
},
		{
"name": "shape-bot-download-release-notes",
"displayName": "Shape Bot Download Release Notes",
"operationCount": 1
},
		{
"name": "shape-bot-endpoint-categories",
"displayName": "Shape Bot Endpoint Categories",
"operationCount": 1
},
		{
"name": "shape-bot-endpoint-list",
"displayName": "Shape Bot Endpoint List",
"operationCount": 1
},
		{
"name": "shape-bot-endpoint-summary",
"displayName": "Shape Bot Endpoint Summary",
"operationCount": 1
},
		{
"name": "shape-bot-endpoints",
"displayName": "Shape Bot Endpoints",
"operationCount": 1
},
		{
"name": "shape-bot-generate-csr",
"displayName": "Shape Bot Generate Csr",
"operationCount": 1
},
		{
"name": "shape-bot-history",
"displayName": "Shape Bot History",
"operationCount": 1
},
		{
"name": "shape-bot-insight-credential-stuffing-attack",
      "displayName": "Shape Bot Insight Credential Stuffing Attack",
      "operationCount": 1
},
		{
"name": "shape-bot-insight-event-bad-bot-reduction",
"displayName": "Shape Bot Insight Event Bad Bot Reduction",
"operationCount": 1
},
		{
"name": "shape-bot-insight-event-unaddressed-automations",
"displayName": "Shape Bot Insight Event Unaddressed Automations",
"operationCount": 1
},
		{
"name": "shape-bot-insight-personal-stats",
"displayName": "Shape Bot Insight Personal Stats",
"operationCount": 1
},
		{
"name": "shape-bot-insight-total-automation",
"displayName": "Shape Bot Insight Total Automation",
"operationCount": 1
},
		{
"name": "shape-bot-list-certificate",
"displayName": "Shape Bot List Certificate",
"operationCount": 1
},
		{
"name": "shape-bot-list-csr",
"displayName": "Shape Bot List Csr",
"operationCount": 1
},
		{
"name": "shape-bot-malicious-endpoints",
"displayName": "Shape Bot Malicious Endpoints",
"operationCount": 1
},
		{
"name": "shape-bot-malicious-transactions-asn",
"displayName": "Shape Bot Malicious Transactions Asn",
"operationCount": 1
},
		{
"name": "shape-bot-malicious-transactions-browser",
"displayName": "Shape Bot Malicious Transactions Browser",
"operationCount": 1
},
		{
"name": "shape-bot-malicious-transactions-ip",
"displayName": "Shape Bot Malicious Transactions Ip",
"operationCount": 1
},
		{
"name": "shape-bot-malicious-transactions-os",
"displayName": "Shape Bot Malicious Transactions Os",
"operationCount": 1
},
		{
"name": "shape-bot-malicious-transactions-ua",
"displayName": "Shape Bot Malicious Transactions Ua",
"operationCount": 1
},
		{
"name": "shape-bot-policies",
"displayName": "Shape Bot Policies",
"operationCount": 1
},
		{
"name": "shape-bot-regions",
"displayName": "Shape Bot Regions",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-endpoint-summary",
"displayName": "Shape Bot Reporting Endpoint Summary",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-forensic-fields",
"displayName": "Shape Bot Reporting Forensic Fields",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-malicious-endpoints",
"displayName": "Shape Bot Reporting Malicious Endpoints",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-malicious-transactions-asn",
"displayName": "Shape Bot Reporting Malicious Transactions Asn",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-malicious-transactions-browser",
"displayName": "Shape Bot Reporting Malicious Transactions Browser",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-malicious-transactions-ip",
"displayName": "Shape Bot Reporting Malicious Transactions Ip",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-malicious-transactions-os",
"displayName": "Shape Bot Reporting Malicious Transactions Os",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-malicious-transactions-ua",
"displayName": "Shape Bot Reporting Malicious Transactions Ua",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-peers-check",
"displayName": "Shape Bot Reporting Peers Check",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-peers-threat-types",
"displayName": "Shape Bot Reporting Peers Threat Types",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-peers-top-good-bots",
"displayName": "Shape Bot Reporting Peers Top Good Bots",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-peers-top-reason-codes",
"displayName": "Shape Bot Reporting Peers Top Reason Codes",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-peers-traffic-overview",
"displayName": "Shape Bot Reporting Peers Traffic Overview",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-good",
"displayName": "Shape Bot Reporting Top Type Good",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-human-dimension-browser",
"displayName": "Shape Bot Reporting Top Type Human Dimension Browser",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-human-dimension-device",
"displayName": "Shape Bot Reporting Top Type Human Dimension Device",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-human-dimension-geolocation",
"displayName": "Shape Bot Reporting Top Type Human Dimension Geolocation",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-human-dimension-platform",
"displayName": "Shape Bot Reporting Top Type Human Dimension Platform",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-apps-timeseries",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Apps Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-asorg",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Asorg",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-attackintent",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Attackintent",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-automation",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Automation",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-endpoints",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Endpoints",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-ip",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Ip",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-top-type-malicious-dimension-ua",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Ua",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-automated-overview-actions",
"displayName": "Shape Bot Reporting Traffic Automated Overview Actions",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-active-ai",
"displayName": "Shape Bot Reporting Traffic Known Active Ai",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-dimension-category",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-dimension-category-actions",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category Actions",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-dimension-category-actions-ai",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category Actions Ai",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-dimension-category-timeseries",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-dimension-endpoint",
"displayName": "Shape Bot Reporting Traffic Known Dimension Endpoint",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-known-statistics-overview",
"displayName": "Shape Bot Reporting Traffic Known Statistics Overview",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-malicious-dimension-attackintent-timeseries",
"displayName": "Shape Bot Reporting Traffic Malicious Dimension Attackintent Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-malicious-overview-actions",
"displayName": "Shape Bot Reporting Traffic Malicious Overview Actions",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-malicious-overview-metrics",
"displayName": "Shape Bot Reporting Traffic Malicious Overview Metrics",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-malicious-overview-timeseries-actions",
"displayName": "Shape Bot Reporting Traffic Malicious Overview Timeseries Actions",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-overview",
"displayName": "Shape Bot Reporting Traffic Overview",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-overview-expanded",
"displayName": "Shape Bot Reporting Traffic Overview Expanded",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-overview-timeseries",
"displayName": "Shape Bot Reporting Traffic Overview Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-reporting-traffic-top-type-known-active",
"displayName": "Shape Bot Reporting Traffic Top Type Known Active",
"operationCount": 1
},
		{
"name": "shape-bot-rollback-certificate-to-default",
"displayName": "Shape Bot Rollback Certificate To Default",
"operationCount": 1
},
		{
"name": "shape-bot-subscribe",
"displayName": "Shape Bot Subscribe",
"operationCount": 1
},
		{
"name": "shape-bot-template",
"displayName": "Shape Bot Template",
"operationCount": 1
},
		{
"name": "shape-bot-top-endpoints",
"displayName": "Shape Bot Top Endpoints",
"operationCount": 1
},
		{
"name": "shape-bot-top-latency-overview",
"displayName": "Shape Bot Top Latency Overview",
"operationCount": 1
},
		{
"name": "shape-bot-top-latency-overview-apps",
"displayName": "Shape Bot Top Latency Overview Apps",
"operationCount": 1
},
		{
"name": "shape-bot-top-malicious-asorg",
"displayName": "Shape Bot Top Malicious Asorg",
"operationCount": 1
},
		{
"name": "shape-bot-top-malicious-automation",
"displayName": "Shape Bot Top Malicious Automation",
"operationCount": 1
},
		{
"name": "shape-bot-top-malicious-ip",
"displayName": "Shape Bot Top Malicious Ip",
"operationCount": 1
},
		{
"name": "shape-bot-top-malicious-ua",
"displayName": "Shape Bot Top Malicious Ua",
"operationCount": 1
},
		{
"name": "shape-bot-top-transactions-app",
"displayName": "Shape Bot Top Transactions App",
"operationCount": 1
},
		{
"name": "shape-bot-top-transactions-categories",
"displayName": "Shape Bot Top Transactions Categories",
"operationCount": 1
},
		{
"name": "shape-bot-top-transactions-endpointlabels",
"displayName": "Shape Bot Top Transactions Endpointlabels",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-good",
"displayName": "Shape Bot Top Type Good",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-human-dimension-browser",
"displayName": "Shape Bot Top Type Human Dimension Browser",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-human-dimension-device",
"displayName": "Shape Bot Top Type Human Dimension Device",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-human-dimension-geolocation",
"displayName": "Shape Bot Top Type Human Dimension Geolocation",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-human-dimension-platform",
"displayName": "Shape Bot Top Type Human Dimension Platform",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-app",
"displayName": "Shape Bot Top Type Malicious Dimension App",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-apps-timeseries",
"displayName": "Shape Bot Top Type Malicious Dimension Apps Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-asorg",
"displayName": "Shape Bot Top Type Malicious Dimension Asorg",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-attackintent",
"displayName": "Shape Bot Top Type Malicious Dimension Attackintent",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-automation",
"displayName": "Shape Bot Top Type Malicious Dimension Automation",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-bfp",
"displayName": "Shape Bot Top Type Malicious Dimension Bfp",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-endpoints",
"displayName": "Shape Bot Top Type Malicious Dimension Endpoints",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-ip",
"displayName": "Shape Bot Top Type Malicious Dimension Ip",
"operationCount": 1
},
		{
"name": "shape-bot-top-type-malicious-dimension-ua",
"displayName": "Shape Bot Top Type Malicious Dimension Ua",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-dimension-attackintent-timeseries",
"displayName": "Shape Bot Traffic Dimension Attackintent Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-dimension-categories-timeseries",
"displayName": "Shape Bot Traffic Dimension Categories Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-malicious-dimension-attackintent-timeseries",
"displayName": "Shape Bot Traffic Malicious Dimension Attackintent Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-malicious-overview-actions",
"displayName": "Shape Bot Traffic Malicious Overview Actions",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-malicious-overview-metrics",
"displayName": "Shape Bot Traffic Malicious Overview Metrics",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-malicious-overview-timeseries-actions",
"displayName": "Shape Bot Traffic Malicious Overview Timeseries Actions",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-overview",
"displayName": "Shape Bot Traffic Overview",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-overview-expanded",
"displayName": "Shape Bot Traffic Overview Expanded",
"operationCount": 1
},
		{
"name": "shape-bot-traffic-overview-timeseries",
"displayName": "Shape Bot Traffic Overview Timeseries",
"operationCount": 1
},
		{
"name": "shape-bot-unarchive",
"displayName": "Shape Bot Unarchive",
"operationCount": 1
},
		{
"name": "shape-bot-unsubscribe",
"displayName": "Shape Bot Unsubscribe",
"operationCount": 1
},
		{
"name": "shape-bot-usage-summary",
"displayName": "Shape Bot Usage Summary",
"operationCount": 1
},
		{
"name": "shape-bot-versions",
"displayName": "Shape Bot Versions",
"operationCount": 2
},
		{
"name": "shape-bot-versions-mobile-base-config",
"displayName": "Shape Bot Versions Mobile Base Config",
"operationCount": 1
},
		{
"name": "shape-csd",
"displayName": "Shape Csd",
"operationCount": 4
},
		{
"name": "shape-csd-affectedUsers",
"displayName": "Shape Csd Affectedusers",
"operationCount": 1
},
		{
"name": "shape-csd-analysis",
"displayName": "Shape Csd Analysis",
"operationCount": 1
},
		{
"name": "shape-csd-approval-status",
"displayName": "Shape Csd Approval Status",
"operationCount": 1
},
		{
"name": "shape-csd-behaviors",
"displayName": "Shape Csd Behaviors",
"operationCount": 1
},
		{
"name": "shape-csd-dashboard",
"displayName": "Shape Csd Dashboard",
"operationCount": 1
},
		{
"name": "shape-csd-formFields",
"displayName": "Shape Csd Formfields",
"operationCount": 1
},
		{
"name": "shape-csd-init",
"displayName": "Shape Csd Init",
"operationCount": 1
},
		{
"name": "shape-csd-inline",
"displayName": "Shape Csd Inline",
"operationCount": 1
},
		{
"name": "shape-csd-justification",
"displayName": "Shape Csd Justification",
"operationCount": 2
},
		{
"name": "shape-csd-metadata-download",
"displayName": "Shape Csd Metadata Download",
"operationCount": 1
},
		{
"name": "shape-csd-networkInteractions",
"displayName": "Shape Csd Networkinteractions",
"operationCount": 1
},
		{
"name": "shape-csd-overview",
"displayName": "Shape Csd Overview",
"operationCount": 1
},
		{
"name": "shape-csd-readStatus",
"displayName": "Shape Csd Readstatus",
"operationCount": 1
},
		{
"name": "shape-csd-subscribe",
"displayName": "Shape Csd Subscribe",
"operationCount": 1
},
		{
"name": "shape-csd-unsubscribe",
"displayName": "Shape Csd Unsubscribe",
"operationCount": 1
},
		{
"name": "shape-dip-app-provision",
"displayName": "Shape Dip App Provision",
"operationCount": 1
},
		{
"name": "shape-dip-application",
"displayName": "Shape Dip Application",
"operationCount": 2
},
		{
"name": "shape-dip-applications",
"displayName": "Shape Dip Applications",
"operationCount": 1
},
		{
"name": "shape-dip-bot-asn",
"displayName": "Shape Dip Bot Asn",
"operationCount": 1
},
		{
"name": "shape-dip-bot-transactions",
"displayName": "Shape Dip Bot Transactions",
"operationCount": 1
},
		{
"name": "shape-dip-bot-urls",
"displayName": "Shape Dip Bot Urls",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-age",
"displayName": "Shape Dip Dashboard Age",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-applications",
"displayName": "Shape Dip Dashboard Applications",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-asn",
"displayName": "Shape Dip Dashboard Asn",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-country",
"displayName": "Shape Dip Dashboard Country",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-session",
"displayName": "Shape Dip Dashboard Session",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-ua",
"displayName": "Shape Dip Dashboard Ua",
"operationCount": 1
},
		{
"name": "shape-dip-dashboard-unique",
"displayName": "Shape Dip Dashboard Unique",
"operationCount": 1
},
		{
"name": "shape-dip-enable",
"displayName": "Shape Dip Enable",
"operationCount": 1
},
		{
"name": "shape-dip-provision-regions",
"displayName": "Shape Dip Provision Regions",
"operationCount": 1
},
		{
"name": "shape-dip-status",
"displayName": "Shape Dip Status",
"operationCount": 1
},
		{
"name": "shape-dip-validate-src-tag-injection",
"displayName": "Shape Dip Validate Src Tag Injection",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-channel",
"displayName": "Shape Recognize Recognize Addon Dashboard Channel",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-conversion",
"displayName": "Shape Recognize Recognize Addon Dashboard Conversion",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-enjoy",
"displayName": "Shape Recognize Recognize Addon Dashboard Enjoy",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-friction-aggregation",
"displayName": "Shape Recognize Recognize Addon Dashboard Friction Aggregation",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-friction-histogram",
"displayName": "Shape Recognize Recognize Addon Dashboard Friction Histogram",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-health",
"displayName": "Shape Recognize Recognize Addon Dashboard Health",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-lift",
"displayName": "Shape Recognize Recognize Addon Dashboard Lift",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-rescue",
"displayName": "Shape Recognize Recognize Addon Dashboard Rescue",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-dashboard-top-reason-code",
"displayName": "Shape Recognize Recognize Addon Dashboard Top Reason Code",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-provision",
"displayName": "Shape Recognize Recognize Addon Provision",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-state",
"displayName": "Shape Recognize Recognize Addon State",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-subscribe",
"displayName": "Shape Recognize Recognize Addon Subscribe",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-unsubscribe",
"displayName": "Shape Recognize Recognize Addon Unsubscribe",
"operationCount": 1
},
		{
"name": "shape-recognize-recognize-addon-validate-src-tag-injection",
"displayName": "Shape Recognize Recognize Addon Validate Src Tag Injection",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-audit",
"displayName": "Shape Safe Sas Block Audit",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-csv-audit",
"displayName": "Shape Safe Sas Block Csv Audit",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-csv-table",
"displayName": "Shape Safe Sas Block Csv Table",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-details",
"displayName": "Shape Safe Sas Block Details",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-feedback",
"displayName": "Shape Safe Sas Block Feedback",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-rule",
"displayName": "Shape Safe Sas Block Rule",
"operationCount": 1
},
		{
"name": "shape-safe-sas-block-table",
"displayName": "Shape Safe Sas Block Table",
"operationCount": 1
},
		{
"name": "shape-safe-sas-ep",
"displayName": "Shape Safe Sas Ep",
"operationCount": 1
},
		{
"name": "shape-safe-sas-feedback",
"displayName": "Shape Safe Sas Feedback",
"operationCount": 1
},
		{
"name": "shape-safe-sas-general-feedback",
"displayName": "Shape Safe Sas General Feedback",
"operationCount": 1
},
		{
"name": "shape-safe-sas-health",
"displayName": "Shape Safe Sas Health",
"operationCount": 1
},
		{
"name": "shape-safe-sas-provision",
"displayName": "Shape Safe Sas Provision",
"operationCount": 1
},
		{
"name": "shape-safe-sas-stats-overview",
"displayName": "Shape Safe Sas Stats Overview",
"operationCount": 2
},
		{
"name": "shape-safe-sas-stats-top-locations",
"displayName": "Shape Safe Sas Stats Top Locations",
"operationCount": 2
},
		{
"name": "shape-safe-sas-stats-top-sources",
"displayName": "Shape Safe Sas Stats Top Sources",
"operationCount": 2
},
		{
"name": "shape-safe-sas-stats-transactions-over-time",
"displayName": "Shape Safe Sas Stats Transactions Over Time",
"operationCount": 1
},
		{
"name": "shape-safe-sas-summary",
"displayName": "Shape Safe Sas Summary",
"operationCount": 1
},
		{
"name": "shape-safe-sas-transaction-details",
"displayName": "Shape Safe Sas Transaction Details",
"operationCount": 2
},
		{
"name": "shape-safe-sas-transaction-device-history",
"displayName": "Shape Safe Sas Transaction Device History",
"operationCount": 1
},
		{
"name": "shape-safe-sas-transaction-locations",
"displayName": "Shape Safe Sas Transaction Locations",
"operationCount": 1
},
		{
"name": "shape-safe-sas-transaction-related-sessions",
"displayName": "Shape Safe Sas Transaction Related Sessions",
"operationCount": 1
},
		{
"name": "shape-safe-sas-transaction-timeline",
"displayName": "Shape Safe Sas Transaction Timeline",
"operationCount": 1
},
		{
"name": "shape-safe-sas-transactions",
"displayName": "Shape Safe Sas Transactions",
"operationCount": 1
},
		{
"name": "shape-safe-sas-transactions-csv",
"displayName": "Shape Safe Sas Transactions Csv",
"operationCount": 1
},
		{
"name": "sid-counters",
"displayName": "Sid Counters",
"operationCount": 1
},
		{
"name": "site",
"displayName": "Site",
"operationCount": 1
},
		{
"name": "site-apis-apps-v1",
      "displayName": "Site Apis Apps V1",
      "operationCount": 1
},
		{
"name": "site-apis-apps-v1-daemonsets",
      "displayName": "Site Apis Apps V1 Daemonsets",
      "operationCount": 1
},
		{
"name": "site-apis-apps-v1-deployments",
      "displayName": "Site Apis Apps V1 Deployments",
      "operationCount": 1
},
		{
"name": "site-apis-apps-v1-replicasets",
      "displayName": "Site Apis Apps V1 Replicasets",
      "operationCount": 1
},
		{
"name": "site-apis-apps-v1-statefulsets",
      "displayName": "Site Apis Apps V1 Statefulsets",
      "operationCount": 1
},
		{
"name": "site-apis-batch-v1",
      "displayName": "Site Apis Batch V1",
      "operationCount": 1
},
		{
"name": "site-apis-batch-v1-jobs",
      "displayName": "Site Apis Batch V1 Jobs",
      "operationCount": 1
},
		{
"name": "site-apis-batch-v1beta1",
      "displayName": "Site Apis Batch V1Beta1",
      "operationCount": 1
},
		{
"name": "site-apis-batch-v1beta1-cronjobs",
      "displayName": "Site Apis Batch V1Beta1 Cronjobs",
      "operationCount": 1
},
		{
"name": "site-edge",
"displayName": "Site Edge",
"operationCount": 1
},
		{
"name": "site-mesh-groups",
"displayName": "Site Mesh Groups",
"operationCount": 5
},
		{
"name": "site-metrics",
"displayName": "Site Metrics",
"operationCount": 1
},
		{
"name": "site-node",
"displayName": "Site Node",
"operationCount": 1
},
		{
"name": "site-pods-metrics",
"displayName": "Site Pods Metrics",
"operationCount": 1
},
		{
"name": "site-status",
"displayName": "Site Status",
"operationCount": 1
},
		{
"name": "site-v1",
"displayName": "Site V1",
"operationCount": 1
},
		{
"name": "site-v1-configmaps",
"displayName": "Site V1 Configmaps",
"operationCount": 1
},
		{
"name": "site-v1-endpoints",
"displayName": "Site V1 Endpoints",
"operationCount": 1
},
		{
"name": "site-v1-nodes",
"displayName": "Site V1 Nodes",
"operationCount": 1
},
		{
"name": "site-v1-persistentvolumeclaims",
"displayName": "Site V1 Persistentvolumeclaims",
"operationCount": 1
},
		{
"name": "site-v1-persistentvolumes",
"displayName": "Site V1 Persistentvolumes",
"operationCount": 1
},
		{
"name": "site-v1-pods",
"displayName": "Site V1 Pods",
"operationCount": 1
},
		{
"name": "site-v1-secrets",
      "displayName": "Site V1 Secrets",
      "operationCount": 1
},
		{
"name": "site-v1-services",
"displayName": "Site V1 Services",
"operationCount": 1
},
		{
"name": "site-virtualmachineinstances-metrics",
"displayName": "Site Virtualmachineinstances Metrics",
"operationCount": 1
},
		{
"name": "sites",
"displayName": "Sites",
"operationCount": 3
},
		{
"name": "sites-global-kubeconfigs",
"displayName": "Sites Global Kubeconfigs",
"operationCount": 2
},
		{
"name": "srv6-network-slices",
"displayName": "Srv6 Network Slices",
"operationCount": 5
},
		{
"name": "staged-signatures",
"displayName": "Staged Signatures",
"operationCount": 1
},
		{
"name": "static-components",
"displayName": "Static Components",
"operationCount": 2
},
		{
"name": "static-tenant-settings-tenant-favicon",
"displayName": "Static Tenant Settings Tenant Favicon",
"operationCount": 1
},
		{
"name": "static-tenant-settings-tenant-image",
"displayName": "Static Tenant Settings Tenant Image",
"operationCount": 1
},
		{
"name": "stats",
"displayName": "Stats",
"operationCount": 1
},
		{
"name": "status",
"displayName": "Status",
"operationCount": 2
},
		{
"name": "status-at-site",
"displayName": "Status At Site",
"operationCount": 1
},
		{
"name": "status-metrics",
"displayName": "Status Metrics",
"operationCount": 1
},
		{
"name": "storage-set-vpc-k8s-hostnames",
"displayName": "Storage Set Vpc K8S Hostnames",
"operationCount": 1
},
		{
"name": "subnets",
"displayName": "Subnets",
"operationCount": 5
},
		{
"name": "suggest-values",
"displayName": "Suggest Values",
"operationCount": 1
},
		{
"name": "support-tenant-managed-tenants",
"displayName": "Support Tenant Managed Tenants",
"operationCount": 1
},
		{
"name": "suspicious-user-logs",
"displayName": "Suspicious User Logs",
"operationCount": 1
},
		{
"name": "suspicious-user-logs-aggregation",
"displayName": "Suspicious User Logs Aggregation",
"operationCount": 1
},
		{
"name": "suspicious-user-logs-scroll",
"displayName": "Suspicious User Logs Scroll",
"operationCount": 2
},
		{
"name": "suspicious-users",
"displayName": "Suspicious Users",
"operationCount": 1
},
		{
"name": "sync-cloud-data-cloud-connect-reapply-vpc-attachment",
"displayName": "Sync Cloud Data Cloud Connect Reapply Vpc Attachment",
"operationCount": 1
},
		{
"name": "sync-cloud-data-discover-vpc",
"displayName": "Sync Cloud Data Discover Vpc",
"operationCount": 1
},
		{
"name": "sync-cloud-data-securemesh-site-v2-cloud-resources",
"displayName": "Sync Cloud Data Securemesh Site V2 Cloud Resources",
"operationCount": 1
},
		{
"name": "tcp-loadbalancers",
"displayName": "Tcp Loadbalancers",
"operationCount": 5
},
		{
"name": "tenant-configurations",
"displayName": "Tenant Configurations",
"operationCount": 5
},
		{
"name": "tenant-domain-owner-assign",
"displayName": "Tenant Domain Owner Assign",
"operationCount": 1
},
		{
"name": "tenant-domain-owner-unassign",
"displayName": "Tenant Domain Owner Unassign",
"operationCount": 1
},
		{
"name": "tenant-idm-events-last-login",
"displayName": "Tenant Idm Events Last Login",
"operationCount": 1
},
		{
"name": "tenant-idm-events-login",
"displayName": "Tenant Idm Events Login",
"operationCount": 1
},
		{
"name": "tenant-idm-events-login-in-time",
"displayName": "Tenant Idm Events Login In Time",
"operationCount": 1
},
		{
"name": "tenant-idm-settings",
"displayName": "Tenant Idm Settings",
"operationCount": 2
},
		{
"name": "tenant-idm-users-inactive",
"displayName": "Tenant Idm Users Inactive",
"operationCount": 1
},
		{
"name": "tenant-lookup",
"displayName": "Tenant Lookup",
"operationCount": 1
},
		{
"name": "tenant-management-delegated-access-subscribe",
      "displayName": "Tenant Management Delegated Access Subscribe",
      "operationCount": 1
},
		{
"name": "tenant-management-delegated-access-unsubscribe",
      "displayName": "Tenant Management Delegated Access Unsubscribe",
      "operationCount": 1
},
		{
"name": "tenant-profiles",
"displayName": "Tenant Profiles",
"operationCount": 5
},
		{
"name": "tenant-request-delete",
"displayName": "Tenant Request Delete",
"operationCount": 1
},
		{
"name": "tenant-settings",
"displayName": "Tenant Settings",
"operationCount": 2
},
		{
"name": "tenant-settings-otp-disable",
"displayName": "Tenant Settings Otp Disable",
"operationCount": 1
},
		{
"name": "tenant-settings-otp-enable",
"displayName": "Tenant Settings Otp Enable",
"operationCount": 1
},
		{
"name": "tenant-settings-tenant-favicon",
"displayName": "Tenant Settings Tenant Favicon",
"operationCount": 1
},
		{
"name": "tenant-settings-tenant-image",
"displayName": "Tenant Settings Tenant Image",
"operationCount": 3
},
		{
"name": "tenant-settings-tenant-logo",
"displayName": "Tenant Settings Tenant Logo",
"operationCount": 1
},
		{
"name": "tenant-support-info",
"displayName": "Tenant Support Info",
"operationCount": 1
},
		{
"name": "tenant-tenant-escalation-doc",
"displayName": "Tenant Tenant Escalation Doc",
"operationCount": 1
},
		{
"name": "tenants-summary",
"displayName": "Tenants Summary",
"operationCount": 1
},
		{
"name": "terraform-force-delete",
"displayName": "Terraform Force Delete",
"operationCount": 1
},
		{
"name": "terraform-parameters",
"displayName": "Terraform Parameters",
"operationCount": 1
},
		{
"name": "terraform-run",
"displayName": "Terraform Run",
"operationCount": 1
},
		{
"name": "test",
"displayName": "Test",
"operationCount": 1
},
		{
"name": "third-party-applications",
"displayName": "Third Party Applications",
"operationCount": 3
},
		{
"name": "ticket-tracking-systems",
"displayName": "Ticket Tracking Systems",
"operationCount": 5
},
		{
"name": "ticket-tracking-systems-jira-projects-issue-types",
"displayName": "Ticket Tracking Systems Jira Projects Issue Types",
"operationCount": 1
},
		{
"name": "ticket-tracking-systems-validate-ticket-tracking-system",
"displayName": "Ticket Tracking Systems Validate Ticket Tracking System",
"operationCount": 1
},
		{
"name": "top-cloud-connects",
"displayName": "Top Cloud Connects",
"operationCount": 1
},
		{
"name": "topology-dc-cluster-group",
"displayName": "Topology Dc Cluster Group",
"operationCount": 1
},
		{
"name": "topology-dc-cluster-groups",
"displayName": "Topology Dc Cluster Groups",
"operationCount": 1
},
		{
"name": "topology-network-route-tables",
"displayName": "Topology Network Route Tables",
"operationCount": 1
},
		{
"name": "topology-route-table",
"displayName": "Topology Route Table",
"operationCount": 1
},
		{
"name": "topology-site",
"displayName": "Topology Site",
"operationCount": 1
},
		{
"name": "topology-site-mesh-group",
"displayName": "Topology Site Mesh Group",
"operationCount": 1
},
		{
"name": "topology-site-mesh-groups",
"displayName": "Topology Site Mesh Groups",
"operationCount": 1
},
		{
"name": "topology-site-networks",
"displayName": "Topology Site Networks",
"operationCount": 1
},
		{
"name": "topology-tgw-route-tables",
"displayName": "Topology Tgw Route Tables",
"operationCount": 1
},
		{
"name": "tpm",
"displayName": "Tpm",
"operationCount": 4
},
		{
"name": "tpm-tpm-preauth",
      "displayName": "Tpm Tpm Preauth",
      "operationCount": 1
},
		{
"name": "tpm-tpm-provision",
"displayName": "Tpm Tpm Provision",
"operationCount": 1
},
		{
"name": "transit-usage",
"displayName": "Transit Usage",
"operationCount": 1
},
		{
"name": "trust-client-suggestion",
"displayName": "Trust Client Suggestion",
"operationCount": 1
},
		{
"name": "trusted-ca-lists",
"displayName": "Trusted Ca Lists",
"operationCount": 5
},
		{
"name": "tunnels",
"displayName": "Tunnels",
"operationCount": 5
},
		{
"name": "udp-loadbalancers",
"displayName": "Udp Loadbalancers",
"operationCount": 5
},
		{
"name": "unlink-tickets",
"displayName": "Unlink Tickets",
"operationCount": 1
},
		{
"name": "unmark-as-non-api",
      "displayName": "Unmark As Non Api",
      "operationCount": 1
},
		{
"name": "update-allow-advertise-on-public",
"displayName": "Update Allow Advertise On Public",
"operationCount": 1
},
		{
"name": "upgrade-os",
"displayName": "Upgrade Os",
"operationCount": 1
},
		{
"name": "upgrade-status",
"displayName": "Upgrade Status",
"operationCount": 1
},
		{
"name": "upgrade-sw",
"displayName": "Upgrade Sw",
"operationCount": 1
},
		{
"name": "usage",
"displayName": "Usage",
"operationCount": 2
},
		{
"name": "usage-details",
"displayName": "Usage Details",
"operationCount": 1
},
		{
"name": "usage-plans-current",
"displayName": "Usage Plans Current",
"operationCount": 1
},
		{
"name": "usage-plans-custom-list",
"displayName": "Usage Plans Custom List",
"operationCount": 1
},
		{
"name": "usb-policys",
"displayName": "Usb Policys",
"operationCount": 5
},
		{
"name": "user-admin-notifications",
"displayName": "User Admin Notifications",
"operationCount": 2
},
		{
"name": "user-admin-notifications-unset",
"displayName": "User Admin Notifications Unset",
"operationCount": 1
},
		{
"name": "user-combined-notifications",
"displayName": "User Combined Notifications",
"operationCount": 2
},
		{
"name": "user-groups",
"displayName": "User Groups",
"operationCount": 2
},
		{
"name": "user-identifications",
"displayName": "User Identifications",
"operationCount": 5
},
		{
"name": "user-notifications",
"displayName": "User Notifications",
"operationCount": 2
},
		{
"name": "user-notifications-unset",
"displayName": "User Notifications Unset",
"operationCount": 1
},
		{
"name": "user-otp-admin-reset",
"displayName": "User Otp Admin Reset",
"operationCount": 1
},
		{
"name": "user-sessions",
"displayName": "User Sessions",
"operationCount": 1
},
		{
"name": "user-settings",
"displayName": "User Settings",
"operationCount": 2
},
		{
"name": "user-settings-idm-disable",
"displayName": "User Settings Idm Disable",
"operationCount": 1
},
		{
"name": "user-settings-idm-enable",
"displayName": "User Settings Idm Enable",
"operationCount": 1
},
		{
"name": "user-settings-image",
"displayName": "User Settings Image",
"operationCount": 3
},
		{
"name": "user-settings-request-initial-access",
      "displayName": "User Settings Request Initial Access",
      "operationCount": 1
},
		{
"name": "user-settings-view-preference",
"displayName": "User Settings View Preference",
"operationCount": 2
},
		{
"name": "validate-config",
"displayName": "Validate Config",
"operationCount": 1
},
		{
"name": "validate-rules",
"displayName": "Validate Rules",
"operationCount": 1
},
		{
"name": "verify",
"displayName": "Verify",
"operationCount": 1
},
		{
"name": "view-internal",
"displayName": "View Internal",
"operationCount": 1
},
		{
"name": "virtual-hosts",
"displayName": "Virtual Hosts",
"operationCount": 5
},
		{
"name": "virtual-k8ss",
"displayName": "Virtual K8Ss",
"operationCount": 5
},
		{
"name": "virtual-networks",
"displayName": "Virtual Networks",
"operationCount": 5
},
		{
"name": "virtual-sites",
"displayName": "Virtual Sites",
"operationCount": 5
},
		{
"name": "vk8s-audit-logs",
"displayName": "Vk8S Audit Logs",
"operationCount": 1
},
		{
"name": "vk8s-events",
"displayName": "Vk8S Events",
"operationCount": 1
},
		{
"name": "voltstack-sites",
"displayName": "Voltstack Sites",
"operationCount": 5
},
		{
"name": "vulnerabilities",
"displayName": "Vulnerabilities",
"operationCount": 1
},
		{
"name": "vulnerability-update-state",
"displayName": "Vulnerability Update State",
"operationCount": 1
},
		{
"name": "waf-exclusion-policys",
"displayName": "Waf Exclusion Policys",
"operationCount": 5
},
		{
"name": "waf-exclusion-suggestion",
"displayName": "Waf Exclusion Suggestion",
"operationCount": 1
},
		{
"name": "waf-threat-campaign",
"displayName": "Waf Threat Campaign",
"operationCount": 1
},
		{
"name": "waf-update",
"displayName": "Waf Update",
"operationCount": 1
},
		{
"name": "was-user-token",
      "displayName": "Was User Token",
      "operationCount": 1
},
		{
"name": "workload-flavors",
"displayName": "Workload Flavors",
"operationCount": 5
},
		{
"name": "workloads",
"displayName": "Workloads",
"operationCount": 5
},
];

export const API_CATALOG_DATA: Readonly<Record<string, ApiCatalogCategory>> = {
	"access-logs": {
"name": "access-logs",
      "displayName": "Access Logs",
      "operations": [
{
"name": "create_access_log",
      "description": "Access Log Query V2.",
      "method": "POST",
"path": "/api/data/namespaces/{namespace}/access_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch access logs.",
      "title": "AccessLogRequestV2",
      "x-displayname": "Access Log Request V2.",
      "x-ves-proto-message": "ves.io.schema.log.AccessLogRequestV2",
      "properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "0",
"x-f5xc-example": "0",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch access logs for a given namespace.",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch access logs for a given namespace.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of following fields in access log may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request path\nrsp_code - response code\nbrowser_type - browser type\ncity - name of the city\ncountry - country code\ndevice_type - device type\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then access logs matching ALL the matchers will be returned in the response.\nExample: query={src=\"service1\", dst=\"service2\"} will return all access logs with source service \"service1\" and the destination service \"service2\"\nquery={vh_name=\"vh1\", rsp_code=~\"4.*\"} will return all access logs for virtual-host \"vh1\" with response code 4xx\n\nOptional: If not specified, all the access logs matching the given tenant, namespace will be returned in the response.",
      "title": "query",
"x-displayname": "Query",
"x-ves-example": "{vh_name=\\\"productpage\\\"}",
"x-f5xc-example": "\"{vh_name=\\\"productpage\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of following fields in access log may be specified in the query. App_type - application type vh_name - name of the virtual host src_site...",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logAccessLogRequestV2",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logAccessLogRequestV2\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logAccessLogRequestV2"
      },
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch access logs for a given namespace.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of following fields in access log may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request path\nrsp_code - response code\nbrowser_type - browser type\ncity - name of the city\ncountry - country code\ndevice_type - device type\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then access logs matching ALL the matchers will be returned in the response.\nExample: query={src=\"service1\", dst=\"service2\"} will return all access logs with source service \"service1\" and the destination service \"service2\"\nquery={vh_name=\"vh1\", rsp_code=~\"4.*\"} will return all access logs for virtual-host \"vh1\" with response code 4xx\n\nOptional: If not specified, all the access logs matching the given tenant, namespace will be returned in the response.",
      "constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"active-alert-policies": {
"name": "active-alert-policies",
"displayName": "Active Alert Policies",
"operations": [
{
"name": "list_active_alert_policies",
"description": "GET Active Alert Policies.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/active_alert_policies",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"alert_policies": {
"type": "array"
},
"alert_policies_status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "alert_policies",
"type": "array",
"description": "A list of references to alert_policy objects."
},
{
"field": "alert_policies_status",
"type": "array",
"description": "The status of alert policies."
}
]
},
{
"name": "create_active_alert_policie",
"description": "Set Active Alert Policies.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/active_alert_policies",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "SetActiveAlertPoliciesRequest is the shape of the request for SetActiveAlertPolicies.",
"title": "SetActiveAlertPoliciesRequest",
"x-displayname": "Request for SetActiveAlertPolicies.",
"x-ves-proto-message": "ves.io.schema.namespace.SetActiveAlertPoliciesRequest",
"properties": {
"alert_policies": {
"type": "array",
"description": "A list of references to alert_policy objects.",
"title": "alert_policies",
"maxItems": 32,
"items": {
"$ref": "#/components/schemas/schemaviewsObjectRefType"
},
"x-displayname": "Alert Policies.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-f5xc-description-short": "List of references to alert_policy objects.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "SetActiveAlertPoliciesRequest is the shape of the request for SetActiveAlertPolicies.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceSetActiveAlertPoliciesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceSetActiveAlertPoliciesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceSetActiveAlertPoliciesRequest"
},
"fieldMetadata": {
"alert_policies": {
"type": "array",
"description": "A list of references to alert_policy objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"active-network-policies": {
"name": "active-network-policies",
"displayName": "Active Network Policies",
"operations": [
{
"name": "list_active_network_policies",
"description": "GET Active Network Policies.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/active_network_policies",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"network_policies": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "network_policies",
"type": "array",
"description": "A list of references to network_policy objects."
}
]
},
{
"name": "create_active_network_policie",
"description": "Set Active Network Policies.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/active_network_policies",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "SetActiveNetworkPoliciesRequest is the shape of the request for SetActiveNetworkPolicies.",
"title": "SetActiveNetworkPoliciesRequest",
"x-displayname": "Request for SetActiveNetworkPolicies.",
"x-ves-proto-message": "ves.io.schema.namespace.SetActiveNetworkPoliciesRequest",
"properties": {
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_policies": {
"type": "array",
"description": "A list of references to network_policy objects.",
"title": "network_policies",
"maxItems": 32,
"items": {
"$ref": "#/components/schemas/schemaviewsObjectRefType"
},
"x-displayname": "Network Policies.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-f5xc-description-short": "List of references to network_policy objects.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "SetActiveNetworkPoliciesRequest is the shape of the request for SetActiveNetworkPolicies.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceSetActiveNetworkPoliciesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceSetActiveNetworkPoliciesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceSetActiveNetworkPoliciesRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_policies": {
"type": "array",
"description": "A list of references to network_policy objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"active-service-policies": {
"name": "active-service-policies",
"displayName": "Active Service Policies",
"operations": [
{
"name": "list_active_service_policies",
"description": "GET Active Service Policies.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/active_service_policies",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"service_policies": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "service_policies",
"type": "array",
"description": "A list of references to service_policy objects."
}
]
},
{
"name": "create_active_service_policie",
"description": "Set Active Service Policies.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/active_service_policies",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "SetActiveServicePoliciesRequest is the shape of the request for SetActiveServicePolicies.",
"title": "SetActiveServicePoliciesRequest",
"x-displayname": "Request for SetActiveServicePolicies.",
"x-ves-proto-message": "ves.io.schema.namespace.SetActiveServicePoliciesRequest",
"properties": {
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"service_policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"title": "service_policies",
"maxItems": 32,
"items": {
"$ref": "#/components/schemas/schemaviewsObjectRefType"
},
"x-displayname": "Service Policies.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-f5xc-description-short": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other.",
"x-f5xc-description-medium": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the correct order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result. For each request, its...",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "SetActiveServicePoliciesRequest is the shape of the request for SetActiveServicePolicies.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceSetActiveServicePoliciesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceSetActiveServicePoliciesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceSetActiveServicePoliciesRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"service_policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"active-staged-signatures": {
"name": "active-staged-signatures",
"displayName": "Active Staged Signatures",
"operations": [
{
"name": "list_active_staged_signatures",
"description": "Active Staged Signatures.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_hosts/{vh_name}/active_staged_signatures",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "vh_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"release_signatures": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "release_signatures",
"type": "array",
"description": "Release Signatures."
}
]
}
]
},
	"addon-services": {
"name": "addon-services",
"displayName": "Addon Services",
"operations": [
{
"name": "list_addon_services",
"description": "List Addon Service.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/addon_services",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_addon_service",
"description": "GET Addon Service.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/addon_services/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"addon-services-activation-status": {
"name": "addon-services-activation-status",
"displayName": "Addon Services Activation Status",
"operations": [
{
"name": "list_addon_services_activation_status",
"description": "Addon Service Activation Status.",
"method": "GET",
"path": "/api/web/namespaces/system/addon_services/{addon_service}/activation-status",
      "dangerLevel": "low",
"parameters": [
{
"name": "addon_service",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "state",
"type": "object",
"description": ""
}
]
}
]
},
	"addon-services-all-activation-status": {
"name": "addon-services-all-activation-status",
"displayName": "Addon Services All Activation Status",
"operations": [
{
"name": "list_addon_services_all_activation_status",
"description": "All Addon Service Activation Status.",
"method": "GET",
"path": "/api/web/namespaces/system/addon_services/{addon_service}/all-activation-status",
      "dangerLevel": "low",
"parameters": [
{
"name": "addon_service",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"activation_states": {
"type": "object"
}
}
},
"responseSummary": [
{
"field": "activation_states",
"type": "object",
"description": "Current state of addon service subscription. The key is the name of the service."
      }
]
}
]
},
	"addon-subscribe": {
"name": "addon-subscribe",
"displayName": "Addon Subscribe",
"operations": [
{
"name": "create_addon_subscribe",
"description": "Subscribe to XC addon services.",
"method": "POST",
"path": "/api/web/namespaces/system/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to one of addon services.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe request.",
"x-ves-oneof-field-addon_choice": "[\"f5xc_appstack_standard\",\"f5xc_big_ip_irule_standard\",\"f5xc_bigip_utilities_standard\",\"f5xc_content_delivery_network_advanced\",\"f5xc_content_delivery_network_standard\",\"f5xc_delegated_access_standard\",\"f5xc_securemesh_advanced\",\"f5xc_securemesh_standard\",\"f5xc_site_management_standard\",\"f5xc_synthetic_monitoring_standard\",\"f5xc_waap_advanced\",\"f5xc_waap_standard\",\"f5xc_web_app_scanning_standard\"]",
      "x-ves-proto-message": "ves.io.schema.subscription.SubscribeRequest",
"properties": {
"f5xc_appstack_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc appstack standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_big_ip_irule_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_bigip_utilities_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_advanced": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc content delivery network advanced.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc content delivery network standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_delegated_access_standard": {
      "allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc delegated access standard.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_advanced": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_site_management_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_synthetic_monitoring_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc synthetic monitoring standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_advanced": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc waap advanced.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc waap standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_web_app_scanning_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to subscribe to one of addon services.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
},
"fieldMetadata": {
"f5xc_appstack_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_big_ip_irule_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_bigip_utilities_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_advanced": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_delegated_access_standard": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_advanced": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_site_management_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_synthetic_monitoring_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_advanced": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_web_app_scanning_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"addon_choice": [
"f5xc_appstack_standard",
"f5xc_big_ip_irule_standard",
"f5xc_bigip_utilities_standard",
"f5xc_content_delivery_network_advanced",
"f5xc_content_delivery_network_standard",
"f5xc_delegated_access_standard",
      "f5xc_securemesh_advanced",
"f5xc_securemesh_standard",
"f5xc_site_management_standard",
"f5xc_synthetic_monitoring_standard",
"f5xc_waap_advanced",
"f5xc_waap_standard",
"f5xc_web_app_scanning_standard"
]
}
}
]
},
	"addon-subscriptions": {
"name": "addon-subscriptions",
"displayName": "Addon Subscriptions",
"operations": [
{
"name": "create_addon_subscription",
"description": "Create Addon Subscription.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/addon_subscriptions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of addon_subscription",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.pbac.addon_subscription.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/addon_subscriptionCreateSpecType"
}
],
"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 addon_subscriptionCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for addon_subscriptionCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "marketplace"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for addon_subscriptionCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a new Addon Subscription with Addon Subscription State.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.addon_service": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.addon_service.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.addon_service.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.addon_service.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_preference": {
"type": "object",
"description": "NotificationPreference preference for receiving addon subscription notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_preference.emails": {
"type": "object",
"description": "Addon Subscription Emails associated with the Addon Subscription.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_preference.support_ticket_id": {
"type": "object",
"description": "SupportTicketId gives the information about ticket created for managed addon subscription.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.status": {
"type": "string",
"description": "Represents the different states of an addon subscription.\n\n- SUBSCRIPTION_PENDING: Subscription Pending\n\nIndicates that the subscription is pending enablement.\n- SUBSCRIPTION_ENABLED: Subscription Enabled\n\nIndicates that the subscription is currently enabled and active.\n- SUBSCRIPTION_DISABLE_PENDING: Subscription Disable Pending\n\nIndicates that the addon disable process is pending.\n- SUBSCRIPTION_DISABLED: Subscription Disabled\n\nIndicates that the addon has been disabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SUBSCRIPTION_PENDING"
}
},
"oneOfVariants": {
"spec.notification_preference.notification_type": [
"emails",
"support_ticket_id"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_addon_subscription",
"description": "Replace Addon Subscription.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/addon_subscriptions/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a addon_subscription",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.pbac.addon_subscription.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/addon_subscriptionReplaceSpecType"
}
],
"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 addon_subscriptionReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for addon_subscriptionReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "marketplace"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for addon_subscriptionReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a given Addon Subscription with with Addon Subscription State.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.addon_service": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.addon_service.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.addon_service.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.addon_service.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_preference": {
"type": "object",
"description": "NotificationPreference preference for receiving addon subscription notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_preference.emails": {
"type": "object",
"description": "Addon Subscription Emails associated with the Addon Subscription.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_preference.support_ticket_id": {
"type": "object",
"description": "SupportTicketId gives the information about ticket created for managed addon subscription.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.status": {
"type": "string",
"description": "Represents the different states of an addon subscription.\n\n- SUBSCRIPTION_PENDING: Subscription Pending\n\nIndicates that the subscription is pending enablement.\n- SUBSCRIPTION_ENABLED: Subscription Enabled\n\nIndicates that the subscription is currently enabled and active.\n- SUBSCRIPTION_DISABLE_PENDING: Subscription Disable Pending\n\nIndicates that the addon disable process is pending.\n- SUBSCRIPTION_DISABLED: Subscription Disabled\n\nIndicates that the addon has been disabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SUBSCRIPTION_PENDING"
}
},
"oneOfVariants": {
"spec.notification_preference.notification_type": [
"emails",
"support_ticket_id"
]
}
},
{
"name": "list_addon_subscriptions",
"description": "List Addon Subscrption.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/addon_subscriptions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_addon_subscription",
"description": "DELETE Addon Subscrption.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/addon_subscriptions/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a addon_subscription",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.pbac.addon_subscription.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for addon_subscriptionDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for addon_subscriptionDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "marketplace"
}
},
{
"name": "get_addon_subscription",
"description": "GET Addon Subscription.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/addon_subscriptions/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"addon-unsubscribe": {
"name": "addon-unsubscribe",
"displayName": "Addon Unsubscribe",
"operations": [
{
"name": "create_addon_unsubscribe",
"description": "Unsubscribe to XC addon services.",
"method": "POST",
"path": "/api/web/namespaces/system/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to one of addon services.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe request.",
"x-ves-oneof-field-addon_choice": "[\"f5xc_appstack_standard\",\"f5xc_big_ip_irule_standard\",\"f5xc_bigip_utilities_standard\",\"f5xc_content_delivery_network_advanced\",\"f5xc_content_delivery_network_standard\",\"f5xc_delegated_access_standard\",\"f5xc_securemesh_advanced\",\"f5xc_securemesh_standard\",\"f5xc_site_management_standard\",\"f5xc_synthetic_monitoring_standard\",\"f5xc_waap_advanced\",\"f5xc_waap_standard\",\"f5xc_web_app_scanning_standard\"]",
      "x-ves-proto-message": "ves.io.schema.subscription.UnsubscribeRequest",
"properties": {
"f5xc_appstack_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc appstack standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_big_ip_irule_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_bigip_utilities_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_advanced": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc content delivery network advanced.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc content delivery network standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_delegated_access_standard": {
      "allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc delegated access standard.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_advanced": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_site_management_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_synthetic_monitoring_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc synthetic monitoring standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_advanced": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc waap advanced.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for f5xc waap standard.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_web_app_scanning_standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to unsubscribe to one of addon services.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
},
"fieldMetadata": {
"f5xc_appstack_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_big_ip_irule_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_bigip_utilities_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_advanced": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_content_delivery_network_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_delegated_access_standard": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_advanced": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_securemesh_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_site_management_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_synthetic_monitoring_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_advanced": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_waap_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"f5xc_web_app_scanning_standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"addon_choice": [
"f5xc_appstack_standard",
"f5xc_big_ip_irule_standard",
"f5xc_bigip_utilities_standard",
"f5xc_content_delivery_network_advanced",
"f5xc_content_delivery_network_standard",
"f5xc_delegated_access_standard",
      "f5xc_securemesh_advanced",
"f5xc_securemesh_standard",
"f5xc_site_management_standard",
"f5xc_synthetic_monitoring_standard",
"f5xc_waap_advanced",
"f5xc_waap_standard",
"f5xc_web_app_scanning_standard"
]
}
}
]
},
	"address-allocators": {
"name": "address-allocators",
"displayName": "Address Allocators",
"operations": [
{
"name": "create_address_allocator",
"description": "Create Address Allocator.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/address_allocators",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of address_allocator",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.address_allocator.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/address_allocatorCreateSpecType"
}
],
"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 address_allocatorCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for address_allocatorCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for address_allocatorCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Address Allocator will create an address allocator object in 'system' namespace of the user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_allocation_scheme": {
"type": "object",
"description": "Decides the scheme to be used to allocate addresses from the configured address pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_allocation_scheme.allocation_unit": {
"type": "integer",
"description": "Prefix length indicating the size of each allocated subnet. For example, if this is\nspecified as 30, subnets of /30 will be allocated from the given address pool.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 32,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.address_allocation_scheme.local_interface_address_offset": {
"type": "integer",
"description": "This is used to derive address for the local interface from the allocated subnet.\n\nIf Local Interface Address Type is set to \"Offset from beginning of Subnet\", this offset value is added\nto the allocated subnet and used as the local interface address. For example, if the allocated subnet is\n192.0.2.0/24 and offset is set to 2 with Local Interface Address Type set to \"Offset from beginning\nof Subnet\", local interface address of 192.0.2.204 is used.\n\nIf Local Interface Address Type is set to \"Offset from end of Subnet\", this offset value is subtracted\nfrom the end of the allocated subnet and used as the local interface address. For example, if the allocated\nsubnet is 192.0.2.0/24 and offset is set to 1 with Local Interface Address Type set to \"Offset from\nend of Subnet\", local interface address of 192.0.2.204 is used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 32,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_allocation_scheme.local_interface_address_type": {
"type": "string",
"description": "Dictates how local interface address is derived from the allocated subnet\n\nUse Nth address of the allocated subnet as the local interface address, N being the\nLocal Interface Address Offset. For example, if the allocated subnet is 192.0.2.0/24,\nLocal Interface Address Offset is set to 2 and Local Interface Address Type is set to\n\"Offset from beginning of Subnet\", local address of 192.0.2.204 is used.\n\nUse Nth last address of the allocated subnet as the local interface address, N being the\nLocal Interface Address Offset. For example, if the allocated subnet is 192.0.2.0/24,\nLocal Interface Address Offset is set to 1 and Local Interface Address Type is set to\n\"Offset from end of Subnet\", local address of 192.0.2.204 is used.\n\nThis case is used for external_connector.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN"
},
"spec.address_pool": {
"type": "array",
"description": "Address pool from which the allocator carves out subnets or addresses to its clients.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.mode": {
"type": "string",
"description": "Mode of the address allocator\n\nAddress allocator is for VERs within the local cluster or site\nAllocation is per site and then per node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "LOCAL"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "list_address_allocators",
"description": "List Address Allocator.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/address_allocators",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_address_allocator",
"description": "DELETE Address Allocator.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/address_allocators/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a address_allocator",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.address_allocator.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for address_allocatorDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for address_allocatorDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_address_allocator",
"description": "GET Address Allocator.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/address_allocators/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"advertise-policys": {
"name": "advertise-policys",
"displayName": "Advertise Policys",
"operations": [
{
"name": "create_advertise_policy",
"description": "Create Advertise Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/advertise_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of advertise_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.advertise_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/advertise_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for advertise_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for advertise_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for advertise_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Advertise_policy object controls how and where a service represented by a given virtual_host object is advertised to consumers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Optional. VIP to advertise. This VIP can be either V4/V6 address\nYou can not specify this if where contains a site or virtual site of type REGIONAL_EDGE or public network\nIf not specified and \"where\" is specified with site or virtual site option,\ninside_vip or outside_vip specified in the site object will be used based on the network type.\nIf inside_vip/outside_vip is not configured in the site object, system use interface IP in the respected networks.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nPort to advertise.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Protocol to advertise.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.public_ip": {
"type": "array",
"description": "Optional. Public VIP to advertise\nThis field is mutually exclusive with where and address fields.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.skip_xff_append": {
"type": "boolean",
"description": "If set, the loadbalancer will not append the remote address to the x-forwarded-for HTTP header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters": {
"type": "object",
"description": "TLS configuration for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_required": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.common_params": {
"type": "object",
"description": "Information of different aspects for TLS authentication related to ciphers,\ncertificates and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.no_client_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.xfcc_header_elements": {
"type": "array",
"description": "X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections.\nIf none are defined, the header will not be added.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.port_choice": [
"port",
"port_ranges"
],
"spec.tls_parameters.client_certificate_verify_choice": [
"client_certificate_optional",
"client_certificate_required",
"no_client_certificate"
],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_advertise_policy",
"description": "Replace Advertise Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/advertise_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a advertise_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.advertise_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/advertise_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for advertise_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for advertise_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for advertise_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Advertise_policy object controls how and where a service represented by a given virtual_host object is advertised to consumers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Optional. VIP to advertise. This VIP can be either V4/V6 address\nYou can not specify this if where contains a site or virtual site of type REGIONAL_EDGE or public network\nIf not specified and \"where\" is specified with site or virtual site option,\ninside_vip or outside_vip specified in the site object will be used based on the network type.\nIf inside_vip/outside_vip is not configured in the site object, system use interface IP in the respected networks.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nPort to advertise.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Protocol to advertise.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.public_ip": {
"type": "array",
"description": "Optional. Public VIP to advertise\nThis field is mutually exclusive with where and address fields.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.skip_xff_append": {
"type": "boolean",
"description": "If set, the loadbalancer will not append the remote address to the x-forwarded-for HTTP header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters": {
"type": "object",
"description": "TLS configuration for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_required": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.common_params": {
"type": "object",
"description": "Information of different aspects for TLS authentication related to ciphers,\ncertificates and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.no_client_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.xfcc_header_elements": {
"type": "array",
"description": "X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections.\nIf none are defined, the header will not be added.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.port_choice": [
"port",
"port_ranges"
],
"spec.tls_parameters.client_certificate_verify_choice": [
"client_certificate_optional",
"client_certificate_required",
"no_client_certificate"
],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
}
},
{
"name": "list_advertise_policys",
"description": "List Advertise Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/advertise_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_advertise_policy",
"description": "DELETE Advertise Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/advertise_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a advertise_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.advertise_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for advertise_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for advertise_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_advertise_policy",
"description": "GET Advertise Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/advertise_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"aggregation": {
"name": "aggregation",
"displayName": "Aggregation",
"operations": [
{
"name": "create_aggregation",
"description": "Access Log Aggregation Query.",
      "method": "POST",
"path": "/api/data/namespaces/{namespace}/access_logs/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for access logs.",
      "title": "AccessLogAggregationRequest",
      "x-displayname": "Access Log Aggregation Request.",
      "x-ves-proto-message": "ves.io.schema.log.AccessLogAggregationRequest",
      "properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of following fields in access log may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request path\nrsp_code - response code\nbrowser_type - browser type\ncity - name of the city\ncountry - country code\ndevice_type - device type\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then access logs matching ALL the matchers will be considered for aggregation.\nExample: query={src=\"service1\", dst=\"service2\"} will consider all access logs with source service \"service1\" and the destination service \"service2\"\n\nOptional: If not specified, all the access logs matching the given tenant, namespace will be considered for aggregation.",
      "title": "query",
"x-displayname": "Query",
"x-ves-example": "{vh_name=\\\"productpage\\\"}",
"x-f5xc-example": "\"{vh_name=\\\"productpage\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of following fields in access log may be specified in the query. App_type - application type vh_name - name of the virtual host src_site...",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for access logs.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logAccessLogAggregationRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logAccessLogAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logAccessLogAggregationRequest"
      },
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of following fields in access log may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request path\nrsp_code - response code\nbrowser_type - browser type\ncity - name of the city\ncountry - country code\ndevice_type - device type\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then access logs matching ALL the matchers will be considered for aggregation.\nExample: query={src=\"service1\", dst=\"service2\"} will consider all access logs with source service \"service1\" and the destination service \"service2\"\n\nOptional: If not specified, all the access logs matching the given tenant, namespace will be considered for aggregation.",
      "constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"ai-data-bfdp-bfdp-enable-feature": {
"name": "ai-data-bfdp-bfdp-enable-feature",
"displayName": "Ai Data Bfdp Bfdp Enable Feature",
"operations": [
{
"name": "create_ai_data_bfdp_bfdp_enable_feature",
"description": "Enable feature.",
"method": "POST",
"path": "/api/ai_data/bfdp/namespaces/system/bfdp/enable_feature",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the GET Provision API.",
      "title": "EnableFeatureRequest",
"x-displayname": "EnableFeature Request.",
"x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureRequest",
"x-f5xc-description-short": "Any payload to be passed on the GET Provision API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bfdpEnableFeatureRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bfdpEnableFeatureRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bfdpEnableFeatureRequest"
}
}
]
},
	"ai-data-bfdp-bfdp-gettoken": {
"name": "ai-data-bfdp-bfdp-gettoken",
      "displayName": "Ai Data Bfdp Bfdp Gettoken",
      "operations": [
{
"name": "create_ai_data_bfdp_bfdp_gettoken",
      "description": "Subscribe to BFDP pipeline.",
"method": "POST",
"path": "/api/ai_data/bfdp/namespaces/system/bfdp/gettoken",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to BFDP CMS.",
"title": "TokenRequest",
      "x-displayname": "Token Request.",
      "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.TokenRequest",
      "properties": {
"product_name": {
"type": "string",
"description": "F5 product's pipeline object name .",
"title": "product_name",
"x-displayname": "Product_name.",
"x-ves-example": "Product name.",
"x-f5xc-example": "product name",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionTokenRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionTokenRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "users"
},
"responseSchema": {
"type": "object",
"properties": {
"token": {
      "type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionTokenRequest"
      },
"fieldMetadata": {
"product_name": {
"type": "string",
"description": "F5 product's pipeline object name .",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "token",
      "type": "string",
"description": "F5 product's pipeline object name ."
}
]
}
]
},
	"ai-data-bfdp-bfdp-refresh-token": {
"name": "ai-data-bfdp-bfdp-refresh-token",
      "displayName": "Ai Data Bfdp Bfdp Refresh Token",
      "operations": [
{
"name": "create_ai_data_bfdp_bfdp_refresh_token",
      "description": "Refresh Token.",
      "method": "POST",
"path": "/api/ai_data/bfdp/namespaces/system/bfdp/refresh_token",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "API to refresh token for a given pipeline.",
      "title": "RefreshTokenRequest",
      "x-displayname": "Refresh Token Request.",
      "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.RefreshTokenRequest",
      "properties": {
"product_name": {
"type": "string",
"description": "Product_name is a pipeline name for which token to be generated.",
      "title": "product_name",
"x-displayname": "Product_name.",
"x-ves-example": "Product_name.",
"x-f5xc-example": "product_name",
"x-f5xc-description-short": "Product_name is a pipeline name for which token to be generated.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "API to refresh token for a given pipeline.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bfdpRefreshTokenRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bfdpRefreshTokenRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "users"
},
"responseSchema": {
"type": "object",
"properties": {
"result": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bfdpRefreshTokenRequest"
      },
"fieldMetadata": {
"product_name": {
"type": "string",
"description": "Product_name is a pipeline name for which token to be generated.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "result",
"type": "string",
"description": "Result will be in JSON format having token in it."
      }
]
}
]
},
	"ai-data-bfdp-bfdp-subscribe": {
"name": "ai-data-bfdp-bfdp-subscribe",
"displayName": "Ai Data Bfdp Bfdp Subscribe",
"operations": [
{
"name": "create_ai_data_bfdp_bfdp_subscribe",
"description": "Subscribe to BFDP pipeline.",
"method": "POST",
"path": "/api/ai_data/bfdp/namespaces/system/bfdp/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to BFDP CMS.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.SubscribeRequest",
"properties": {
"product_name": {
"type": "string",
"description": "F5 product's pipeline object name .",
"title": "product_name",
"x-displayname": "Product_name.",
"x-ves-example": "Product name.",
"x-f5xc-example": "product name",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"configured_tenant_id": {
"type": "string"
},
"pipeline_id": {
"type": "string"
},
"pipeline_name": {
"type": "string"
},
"token": {
      "type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
},
"fieldMetadata": {
"product_name": {
"type": "string",
"description": "F5 product's pipeline object name .",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "configured_tenant_id",
"type": "string",
"description": "F5 product's pipeline configured tenant ."
},
{
"field": "pipeline_id",
"type": "string",
"description": "F5 product's pipeline ID for which this tenant is configured."
},
{
"field": "pipeline_name",
"type": "string",
"description": "F5 product's pipeline name for which this tenant is configured."
},
{
"field": "token",
      "type": "string",
"description": "F5 product's pipeline token to ingest data ."
      }
]
}
]
},
	"ai-data-bfdp-bfdp-unsubscribe": {
"name": "ai-data-bfdp-bfdp-unsubscribe",
"displayName": "Ai Data Bfdp Bfdp Unsubscribe",
"operations": [
{
"name": "create_ai_data_bfdp_bfdp_unsubscribe",
"description": "Unsubscribe to BFDP pipeline.",
"method": "POST",
"path": "/api/ai_data/bfdp/namespaces/system/bfdp/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to BFDP CMS.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.UnsubscribeRequest",
"properties": {
"product_name": {
"type": "string",
"description": "F5 product's pipeline object name .",
"title": "product_name",
"x-displayname": "Product_name.",
"x-ves-example": "Product name.",
"x-f5xc-example": "product name",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
},
"fieldMetadata": {
"product_name": {
"type": "string",
"description": "F5 product's pipeline object name .",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"alert-confirm": {
"name": "alert-confirm",
"displayName": "Alert Confirm",
"operations": [
{
"name": "create_alert_confirm",
"description": "Confirm Alert Receiver.",
"method": "POST",
"path": "/api/alert/namespaces/{namespace}/alert_receivers/{name}/confirm",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to confirm the Alert Receiver.",
"title": "Confirm Alert Receiver Request",
"x-displayname": "Confirm Alert Receiver Request.",
"x-ves-proto-message": "ves.io.schema.alert_receiver.ConfirmAlertReceiverRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the alert receiver.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Email1",
"x-f5xc-example": "email1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the alert receiver is configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ns1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the alert receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"verification_code": {
"type": "string",
"description": "Verification Code received by the user.",
"title": "Verification Code",
"x-displayname": "Verification Code.",
"x-ves-example": "123456",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.len_bytes": "6"
},
"x-f5xc-example": "123456",
"x-validation-rules": {
"ves.io.schema.rules.string.len_bytes": "6"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_receiverConfirmAlertReceiverRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_receiverConfirmAlertReceiverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "alert"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for alert_receiverConfirmAlertReceiverRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the alert receiver.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the alert receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"verification_code": {
"type": "string",
"description": "Verification Code received by the user.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"alert-match": {
"name": "alert-match",
"displayName": "Alert Match",
"operations": [
{
"name": "create_alert_match",
"description": "GET Alert Policy Match.",
"method": "POST",
"path": "/api/alert/namespaces/{namespace}/alert_policy/match",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request message for GetAlertPolicyMatch RPC,\ndescribing alert to match against alert policies.",
"title": "Alert Policy Match Request",
"x-displayname": "Alert Policy Match Request.",
"x-ves-proto-message": "ves.io.schema.alert_policy.AlertPolicyMatchRequest",
"properties": {
"labels": {
"type": "object",
"description": "\"namespace\": \"system\",\n\"tenant\" :\"example-tenant\",\n\"alertname\": \"podXcrash\",\n\"group\": \"IaaS\",\n\"severity\": \"critical\"\n},\nAlert labels to find match against alert policies\nrequires tenant and namespace to be defined labels map.",
"title": "labels",
"x-displayname": "Labels",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.map.max_pairs": "50",
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "\"labels\"{",
"x-validation-rules": {
"ves.io.schema.rules.map.max_pairs": "50",
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "\"namespace\": \"system\", \"tenant\" :\"example-tenant\", \"alertname\": \"podXcrash\", \"group\": \"IaaS\", \"severity\": \"critical\" }, Alert labels to find match...",
"x-f5xc-description-medium": "\"namespace\": \"system\", \"tenant\" :\"example-tenant\", \"alertname\": \"podXcrash\", \"group\": \"IaaS\", \"severity\": \"critical\" }, Alert labels to find match against alert policies requires tenant and namespace to be defined labels map.",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the configuration object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ns1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The namespace in which the configuration object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request message for GetAlertPolicyMatch RPC, describing alert to match against alert policies.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_policyAlertPolicyMatchRequest",
"required_fields": [
"labels",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_policyAlertPolicyMatchRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  labels: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"labels\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"alert_match": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"labels": "value",
"namespace": "value"
}
},
"requiredFields": [
"labels",
"namespace"
],
"description": "Minimum configuration for alert_policyAlertPolicyMatchRequest"
},
"fieldMetadata": {
"labels": {
"type": "object",
"description": "\"namespace\": \"system\",\n\"tenant\" :\"example-tenant\",\n\"alertname\": \"podXcrash\",\n\"group\": \"IaaS\",\n\"severity\": \"critical\"\n},\nAlert labels to find match against alert policies\nrequires tenant and namespace to be defined labels map.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the configuration object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "alert_match",
"type": "array",
"description": "X-example:{\"alert_match\":[{\"policy_name\":\"policy1\",\"policy_active\":1},{\"policy_name\":\"policy4\"}]}\nList of Alert Policies that match given requested namespace,labels."
}
]
}
]
},
	"alert-policys": {
"name": "alert-policys",
"displayName": "Alert Policys",
"operations": [
{
"name": "create_alert_policy",
"description": "Create Alert Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/alert_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of alert_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.alert_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/alert_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alert_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new Alert Policy Object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters": {
"type": "object",
"description": "Set of notification parameters to decide how and when the alert notifications should be sent to the receivers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.custom": {
"type": "object",
"description": "Specify list of custom labels to group/aggregate the alerts.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.group_interval": {
"type": "string",
"description": "Group Interval is used to specify how long to wait before sending a notification about new alerts\nthat are added to the group for which an initial notification has already been sent.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_interval defaults to \"1m\"",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.group_wait": {
"type": "string",
"description": "Time value used to specify how long to initially wait for an inhibiting alert to arrive or\ncollect more alerts for the same group.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_wait defaults to \"30s\"",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.individual": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.repeat_interval": {
"type": "string",
"description": "Repeat Interval is used to specify how long to wait before sending a notification again if it\nhas already been sent successfully.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_interval defaults to \"4h\"",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.ves_io_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.receivers": {
"type": "array",
"description": "List of Alert Receivers where the alerts will be sent.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "Set of routes to match the incoming alert.\nThe routes are evaluated in the specified order and terminates on the first match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.notification_parameters.group_by": [
"custom",
"default",
"individual",
"ves_io_group"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_alert_policy",
"description": "Replace Alert Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/alert_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a alert_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.alert_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/alert_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alert_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of the Alert Policy Object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters": {
"type": "object",
"description": "Set of notification parameters to decide how and when the alert notifications should be sent to the receivers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.custom": {
"type": "object",
"description": "Specify list of custom labels to group/aggregate the alerts.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.group_interval": {
"type": "string",
"description": "Group Interval is used to specify how long to wait before sending a notification about new alerts\nthat are added to the group for which an initial notification has already been sent.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_interval defaults to \"1m\"",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.group_wait": {
"type": "string",
"description": "Time value used to specify how long to initially wait for an inhibiting alert to arrive or\ncollect more alerts for the same group.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_wait defaults to \"30s\"",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.individual": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.repeat_interval": {
"type": "string",
"description": "Repeat Interval is used to specify how long to wait before sending a notification again if it\nhas already been sent successfully.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_interval defaults to \"4h\"",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.notification_parameters.ves_io_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.receivers": {
"type": "array",
"description": "List of Alert Receivers where the alerts will be sent.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "Set of routes to match the incoming alert.\nThe routes are evaluated in the specified order and terminates on the first match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.notification_parameters.group_by": [
"custom",
"default",
"individual",
"ves_io_group"
]
}
},
{
"name": "list_alert_policys",
"description": "List Alert Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/alert_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_alert_policy",
"description": "DELETE Alert Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/alert_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a alert_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.alert_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
}
},
{
"name": "get_alert_policy",
"description": "GET Alert Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/alert_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"alert-receivers": {
"name": "alert-receivers",
"displayName": "Alert Receivers",
"operations": [
{
"name": "create_alert_receiver",
"description": "Create Alert Receiver.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/alert_receivers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of alert_receiver",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.alert_receiver.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/alert_receiverCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Alert receiver for F5 XC alert notifications",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "receiver",
"fields": [
"spec.email",
"spec.opsgenie",
"spec.pagerduty",
"spec.slack",
"spec.sms",
"spec.webhook"
],
"required": true,
"reason": "Choose exactly one notification channel"
}
],
"example_yaml": "metadata:\n  name: example-alert-receiver\n  namespace: system\nspec:\n  email:\n    email_address: alerts@example.com\n",
"example_json": "{\n  \"metadata\": {\"name\": \"example-alert-receiver\", \"namespace\": \"system\"},\n  \"spec\": {\n    \"email\": {\"email_address\": \"alerts@example.com\"}\n  }\n}\n"
},
"x-f5xc-cli-domain": "alert"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-alert-receiver",
"namespace": "system"
},
"spec": {
"email": {
"email_address": "alerts@example.com"
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Alert receiver for F5 XC alert notifications"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new Alert Receiver object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.email": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.email.email": {
"type": "string",
"description": "Email ID of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.opsgenie": {
"type": "object",
"description": "OpsGenie configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.opsgenie.api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.opsgenie.url": {
"type": "string",
"description": "URL to send API requests to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.pagerduty": {
"type": "object",
"description": "PagerDuty configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pagerduty.routing_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pagerduty.url": {
"type": "string",
"description": "URL to send API requests to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slack": {
"type": "object",
"description": "Slack configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slack.channel": {
"type": "string",
"description": "Channel or user to send notifications to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-z0-9-_]{1,80}$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slack.url": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sms": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sms.contact_number": {
"type": "string",
"description": "Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code]",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.webhook": {
"type": "object",
"description": "Webhook configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.webhook.http_config": {
"type": "object",
"description": "Configuration for HTTP endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.webhook.url": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.receiver": [
"email",
"opsgenie",
"pagerduty",
"slack",
"sms",
"webhook"
],
"spec.opsgenie.api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.pagerduty.routing_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.slack.url.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.webhook.http_config.auth_choice": [
      "auth_token",
      "basic_auth",
      "client_cert_obj",
"no_authorization"
      ],
"spec.webhook.http_config.tls_choice": [
"no_tls",
"use_tls"
],
"spec.webhook.url.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_alert_receiver",
"description": "Replace Alert Receiver.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/alert_receivers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a alert_receiver",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.alert_receiver.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/alert_receiverReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Alert receiver for F5 XC alert notifications",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "receiver",
"fields": [
"spec.email",
"spec.opsgenie",
"spec.pagerduty",
"spec.slack",
"spec.sms",
"spec.webhook"
],
"required": true,
"reason": "Choose exactly one notification channel"
}
],
"example_yaml": "metadata:\n  name: example-alert-receiver\n  namespace: system\nspec:\n  email:\n    email_address: alerts@example.com\n",
"example_json": "{\n  \"metadata\": {\"name\": \"example-alert-receiver\", \"namespace\": \"system\"},\n  \"spec\": {\n    \"email\": {\"email_address\": \"alerts@example.com\"}\n  }\n}\n"
},
"x-f5xc-cli-domain": "alert"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-alert-receiver",
"namespace": "system"
},
"spec": {
"email": {
"email_address": "alerts@example.com"
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Alert receiver for F5 XC alert notifications"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of an Alert Receiver object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.email": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.email.email": {
"type": "string",
"description": "Email ID of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.opsgenie": {
"type": "object",
"description": "OpsGenie configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.opsgenie.api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.opsgenie.url": {
"type": "string",
"description": "URL to send API requests to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.pagerduty": {
"type": "object",
"description": "PagerDuty configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pagerduty.routing_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pagerduty.url": {
"type": "string",
"description": "URL to send API requests to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slack": {
"type": "object",
"description": "Slack configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slack.channel": {
"type": "string",
"description": "Channel or user to send notifications to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-z0-9-_]{1,80}$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slack.url": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sms": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sms.contact_number": {
"type": "string",
"description": "Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code]",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.webhook": {
"type": "object",
"description": "Webhook configuration to send alert notifications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.webhook.http_config": {
"type": "object",
"description": "Configuration for HTTP endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.webhook.url": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.receiver": [
"email",
"opsgenie",
"pagerduty",
"slack",
"sms",
"webhook"
],
"spec.opsgenie.api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.pagerduty.routing_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.slack.url.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.webhook.http_config.auth_choice": [
      "auth_token",
      "basic_auth",
      "client_cert_obj",
"no_authorization"
      ],
"spec.webhook.http_config.tls_choice": [
"no_tls",
"use_tls"
],
"spec.webhook.url.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_alert_receivers",
"description": "List Alert Receiver.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/alert_receivers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_alert_receiver",
"description": "DELETE Alert Receiver.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/alert_receivers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a alert_receiver",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.alert_receiver.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_receiverDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_receiverDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "alert"
}
},
{
"name": "get_alert_receiver",
"description": "GET Alert Receiver.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/alert_receivers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"alert-test": {
"name": "alert-test",
"displayName": "Alert Test",
"operations": [
{
"name": "create_alert_test",
"description": "Test Alert Receiver.",
"method": "POST",
"path": "/api/alert/namespaces/{namespace}/alert_receivers/{name}/test",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to send test alert.",
"title": "Test Alert Receiver Request",
"x-displayname": "Test Alert Receiver Request.",
"x-ves-proto-message": "ves.io.schema.alert_receiver.TestAlertReceiverRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the alert receiver.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Slack1",
"x-f5xc-example": "slack1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the alert receiver is configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ns1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the alert receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_receiverTestAlertReceiverRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_receiverTestAlertReceiverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "alert"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for alert_receiverTestAlertReceiverRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the alert receiver.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the alert receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"alert-verify": {
"name": "alert-verify",
"displayName": "Alert Verify",
"operations": [
{
"name": "create_alert_verify",
"description": "Verify Alert Receiver.",
"method": "POST",
"path": "/api/alert/namespaces/{namespace}/alert_receivers/{name}/verify",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Send request to verify Alert Receiver.",
"title": "Verify Alert Receiver Request",
"x-displayname": "Verify Alert Receiver Request.",
"x-ves-proto-message": "ves.io.schema.alert_receiver.VerifyAlertReceiverRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the alert receiver.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Email1",
"x-f5xc-example": "email1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the alert receiver is configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ns1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the alert receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_receiverVerifyAlertReceiverRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_receiverVerifyAlertReceiverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "alert"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for alert_receiverVerifyAlertReceiverRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the alert receiver.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the alert receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"alerts": {
"name": "alerts",
"displayName": "Alerts",
"operations": [
{
"name": "list_alerts",
"description": "GET Alerts.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/alerts",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "inactive",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "silenced",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "inhibited",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "unprocessed",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "data",
"type": "string",
"description": "Data contains the list of alerts."
}
]
}
]
},
	"all-application-inventory": {
"name": "all-application-inventory",
"displayName": "All Application Inventory",
"operations": [
{
"name": "create_all_application_inventory",
"description": "All Application Objects Inventory.",
"method": "POST",
"path": "/api/config/namespaces/system/all_application_inventory",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for inventory of application related objects.",
"title": "AllApplicationInventoryRequest",
"x-displayname": "All Application related objects inventory request.",
"x-ves-proto-message": "ves.io.schema.namespace.AllApplicationInventoryRequest",
"properties": {
"bigip_virtual_server_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceBIGIPVirtualServerInventoryFilterType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for cdn load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for http load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceNGINXOneServerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for nginx one server filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceTCPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for tcp load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"third_party_application_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceThirdPartyApplicationFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for third party application filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceUDPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for udp load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for inventory of application related objects.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceAllApplicationInventoryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceAllApplicationInventoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"loadbalancers": {
"type": "integer"
},
"origin_pools": {
"type": "integer"
},
"services_discovered": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceAllApplicationInventoryRequest"
},
"fieldMetadata": {
"bigip_virtual_server_filter": {
"type": "object",
"description": "BIG-IP Virtual Server Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_server_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with BIG-IP Virtual Server with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_server_filter.waf_configured": {
"type": "boolean",
"description": "Filter results with BIG-IP Virtual Server with WAF configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter": {
"type": "object",
"description": "HTTP Loadbalancer Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_definition": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Definition.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_protection": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Protection configured.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_schema_validation": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Schema Validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.bot_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Bot Protection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.client_blocking": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Blocking.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.client_side_defense": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Side Defense configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.cookie_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Cookie Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.cors_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CORS Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.csrf_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CSRF Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.data_guard": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Data Guard.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ddos_auto_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ddos_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS detection enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.default_loadbalancer": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Default Loadbalancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.graph_ql_inspection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with GraphQL Inspection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.http_only": {
"type": "boolean",
"description": "Filter results with HTTP only loadbalancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ip_reputation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with IP Reputation configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.malicious_user_detection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Detection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.malicious_user_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.malware_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malware Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.mutual_tls": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with mTLS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.origin_server_subset": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Origin Server Subset.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"cdn_load_balancer_filter.routes": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.slow_ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Slow DDoS Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.trusted_client": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.trusted_client_ip_headers": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client IP Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.waf": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.waf_exclusion": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF Exclusion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter": {
"type": "object",
"description": "HTTP Loadbalancer Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_definition": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Definition.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_protection": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Protection configured.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_schema_validation": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Schema Validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.bot_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Bot Protection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.client_blocking": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Blocking.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.client_side_defense": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Side Defense configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.cookie_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Cookie Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.cors_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CORS Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.csrf_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CSRF Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.data_guard": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Data Guard.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ddos_auto_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ddos_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS detection enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.default_loadbalancer": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Default Loadbalancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.graph_ql_inspection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with GraphQL Inspection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.http_only": {
"type": "boolean",
"description": "Filter results with HTTP only loadbalancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ip_reputation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with IP Reputation configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.malicious_user_detection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Detection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.malicious_user_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.malware_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malware Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.mutual_tls": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with mTLS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.origin_server_subset": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Origin Server Subset.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"http_load_balancer_filter.routes": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.slow_ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Slow DDoS Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.trusted_client": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.trusted_client_ip_headers": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client IP Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.waf": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.waf_exclusion": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF Exclusion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter": {
"type": "object",
"description": "NGINX One Server Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with NGINX One Server with specified API Discovery enablement state.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter.waf_configured": {
"type": "boolean",
"description": "Filter results with NGINX One Server with specified WAF enablement state.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter": {
"type": "object",
"description": "TCP Loadbalancer inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"tcp_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.tls_encryption": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers with TLS Encryption configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"third_party_application_filter": {
"type": "object",
"description": "Third Party Application Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"third_party_application_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with Third Party Application with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter": {
"type": "object",
"description": "UDP Loadbalancer inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"udp_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bigip_virtual_servers",
"type": "object",
"description": ""
},
{
"field": "cdn_loadbalancers",
"type": "object",
"description": ""
},
{
"field": "http_loadbalancers",
"type": "object",
"description": ""
},
{
"field": "loadbalancers",
"type": "integer",
"description": "Number of HTTP and TCP Load Balancers configured."
},
{
"field": "nginx_one_servers",
"type": "object",
"description": ""
},
{
"field": "origin_pools",
"type": "integer",
"description": "Number of origin pools configured."
},
{
"field": "services_discovered",
"type": "integer",
"description": "Number of services discovered."
},
{
"field": "tcp_loadbalancers",
"type": "object",
"description": ""
},
{
"field": "third_party_applications",
"type": "object",
"description": ""
},
{
"field": "udp_loadbalancers",
"type": "object",
"description": ""
}
]
}
]
},
	"all-application-inventory-waf-filters": {
"name": "all-application-inventory-waf-filters",
"displayName": "All Application Inventory Waf Filters",
"operations": [
{
"name": "create_all_application_inventory_waf_filter",
"description": "All Application Objects Inventory with WAF Filters.",
"method": "POST",
"path": "/api/config/namespaces/system/all_application_inventory_waf_filters",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for inventory of application related objects with WAF Filter.",
"title": "AllApplicationInventoryWafFilterRequest",
"x-displayname": "All Application related objects inventory request with WAF Filter.",
"x-ves-oneof-field-waf_filter_choice": "[\"exclusion_signature_id\",\"exclusion_violation_type\"]",
"x-ves-proto-message": "ves.io.schema.namespace.AllApplicationInventoryWafFilterRequest",
"properties": {
"exclusion_signature_id": {
"type": "integer",
"description": "Exclusive with [exclusion_violation_type]",
"title": "WAF Exclusion Rule Signature Id",
"format": "int64",
"x-displayname": "WAF Exclusion Rule Signature ID.",
"x-f5xc-description-short": "Exclusive with [exclusion_violation_type].",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"exclusion_violation_type": {
"allOf": [
{
"$ref": "#/components/schemas/app_firewallAppFirewallViolationType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for inventory of application related objects with WAF Filter.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceAllApplicationInventoryWafFilterRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceAllApplicationInventoryWafFilterRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"cdn_loadbalancers": {
"type": "array"
},
"http_loadbalancers": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceAllApplicationInventoryWafFilterRequest"
},
"fieldMetadata": {
"exclusion_signature_id": {
"type": "integer",
"description": "Exclusive with [exclusion_violation_type]",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"exclusion_violation_type": {
"type": "string",
"description": "List of all supported Violation Types\n\nVIOL_NONE\nVIOL_FILETYPE\nVIOL_METHOD\nVIOL_MANDATORY_HEADER\nVIOL_HTTP_RESPONSE_STATUS\nVIOL_REQUEST_MAX_LENGTH\nVIOL_FILE_UPLOAD\nVIOL_FILE_UPLOAD_IN_BODY\nVIOL_XML_MALFORMED\nVIOL_JSON_MALFORMED\nVIOL_ASM_COOKIE_MODIFIED\nVIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS\nVIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE\nVIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT\nVIOL_HTTP_PROTOCOL_NULL_IN_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION\nVIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START\nVIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING\nVIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS\nVIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER\nVIOL_EVASION_DIRECTORY_TRAVERSALS\nVIOL_MALFORMED_REQUEST\nVIOL_EVASION_MULTIPLE_DECODING\nVIOL_DATA_GUARD\nVIOL_EVASION_APACHE_WHITESPACE\nVIOL_COOKIE_MODIFIED\nVIOL_EVASION_IIS_UNICODE_CODEPOINTS\nVIOL_EVASION_IIS_BACKSLASHES\nVIOL_EVASION_PERCENT_U_DECODING\nVIOL_EVASION_BARE_BYTE_DECODING\nVIOL_EVASION_BAD_UNESCAPE\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING\nVIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST\nVIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS\nVIOL_ENCODING\nVIOL_COOKIE_MALFORMED\nVIOL_GRAPHQL_FORMAT\nVIOL_GRAPHQL_MALFORMED\nVIOL_GRAPHQL_INTROSPECTION_QUERY.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIOL_NONE"
}
},
"oneOfVariants": {
"waf_filter_choice": [
"exclusion_signature_id",
"exclusion_violation_type"
]
},
"responseSummary": [
{
"field": "cdn_loadbalancers",
"type": "array",
"description": "Application Inventory of configured CDN Loadbalancers with WAF Filters."
},
{
"field": "http_loadbalancers",
"type": "array",
"description": "Application Inventory of configured HTTP Loadbalancers with WAF Filters."
}
]
}
]
},
	"all-ns-alerts": {
"name": "all-ns-alerts",
"displayName": "All Ns Alerts",
"operations": [
{
"name": "list_all_ns_alerts",
"description": "GET Alerts.",
"method": "GET",
"path": "/api/data/namespaces/system/all_ns_alerts",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "inactive",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "silenced",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "inhibited",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "unprocessed",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "data",
"type": "string",
"description": "Data contains the list of alerts."
}
]
}
]
},
	"allowed-tenants": {
"name": "allowed-tenants",
"displayName": "Allowed Tenants",
"operations": [
{
"name": "create_allowed_tenant",
"description": "Create Allowed Tenant.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/allowed_tenants",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of allowed_tenant",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.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/tenant_managementallowed_tenantCreateSpecType"
}
],
"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 tenant_managementallowed_tenantCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementallowed_tenantCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementallowed_tenantCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a allowed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_groups": {
"type": "array",
"description": "List of references to allowed user_group objects for access in to tenant.\nAdmin can use this to control API access by users from from original tenant into an allowed tenant.\nUser access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_id": {
"type": "string",
"description": "Specify the Tenant ID of the Original Tenant which is allowed to manage.\nNOTE: this is the name of the tenant configuration obj. Not UID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_allowed_tenant",
"description": "Replace Allowed Tenant.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/allowed_tenants/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a allowed_tenant",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.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/allowed_tenantReplaceSpecType"
}
],
"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 allowed_tenantReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for allowed_tenantReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for allowed_tenantReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a allowed_tenant instance including its metadata like labels, description etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_groups": {
"type": "array",
"description": "List of references to allowed user_group objects for access in to tenant.\nAdmin can use this to control API access by users from from original tenant into an allowed tenant.\nUser access from original tenant into an allowed tenant will be associated to underlying roles in this user_group.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_id": {
"type": "string",
"description": "Specify the Tenant ID of the Original Tenant which is allowed to manage.\nNOTE: this is the name of the tenant configuration obj. Not UID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_allowed_tenants",
"description": "List Allowed Tenant.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/allowed_tenants",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_allowed_tenant",
"description": "DELETE Allowed Tenant.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/allowed_tenants/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a allowed_tenant",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for allowed_tenantDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for allowed_tenantDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_allowed_tenant",
"description": "GET Allowed Tenant.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/allowed_tenants/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"allowed-tenants-support-tenant-access": {
"name": "allowed-tenants-support-tenant-access",
      "displayName": "Allowed Tenants Support Tenant Access",
      "operations": [
{
"name": "list_allowed_tenants_support_tenant_access",
      "description": "GET Support Tenant Access.",
      "method": "GET",
"path": "/api/web/namespaces/system/allowed_tenants/support-tenant/access",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "access_config",
      "type": "object",
"description": ""
}
]
},
{
"name": "create_allowed_tenants_support_tenant_acce",
"description": "Update Support Tenant Access.",
      "method": "POST",
"path": "/api/web/namespaces/system/allowed_tenants/support-tenant/access",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to update access control configurations for a support tenant.",
      "title": "UpdateSupportTenantAccessReq",
      "x-displayname": "Support Tenant Access Update Request.",
      "x-ves-proto-message": "ves.io.schema.tenant_management.allowed_tenant.UpdateSupportTenantAccessReq",
      "properties": {
"access_config": {
      "allOf": [
{
"$ref": "#/components/schemas/allowed_tenantAllowedAccessConfig"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to update access control configurations for a support tenant.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for allowed_tenantUpdateSupportTenantAccessReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for allowed_tenantUpdateSupportTenantAccessReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for allowed_tenantUpdateSupportTenantAccessReq"
      },
"fieldMetadata": {
"access_config": {
      "type": "object",
"description": "Shape for storing access config for a tenant.\nDefault field OPTIONS - disable, read-only, read_write provided for easy access controls\nand underlying allowed groups corresponding to each usecase will be updated accordingly.\nMainly used for storing state for support related tenant access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"access_config.disable": {
      "type": "boolean",
"description": "Temporarily revoke access to this tenant.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"access_config.read_only": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"access_config.read_write_all": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"access_config.read_write_ns": {
      "type": "object",
"description": "Shape of read write access control for namespaces.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"access_config.read_write_ns.namespaces": {
      "type": "array",
"description": "List of namespace name read/write access needs to be restricted to.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"access_config.access_type_choice": [
      "read_only",
"read_write_all",
"read_write_ns"
]
},
"responseSummary": [
{
"field": "access_config",
      "type": "object",
"description": ""
}
]
}
]
},
	"api-crawlers": {
"name": "api-crawlers",
      "displayName": "Api Crawlers",
      "operations": [
{
"name": "create_api_crawler",
      "description": "Create API Crawler.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_crawlers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of api_crawler",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_crawler.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/api_crawlerCreateSpecType"
      }
],
"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 api_crawlerCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_crawlerCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for api_crawlerCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "API Crawler Configuration.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_api_crawler",
      "description": "Replace API crawler.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/api_crawlers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a api_crawler",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_crawler.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/api_crawlerReplaceSpecType"
      }
],
"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 api_crawlerReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_crawlerReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for api_crawlerReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "API Crawler Configuration.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_api_crawlers",
      "description": "List API Crawler.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_crawlers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_api_crawler",
      "description": "DELETE API Crawler.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/api_crawlers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a api_crawler",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_crawler.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_crawlerDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_crawlerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      }
},
{
"name": "get_api_crawler",
      "description": "GET API crawler.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_crawlers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"api-credentials": {
"name": "api-credentials",
      "displayName": "Api Credentials",
      "operations": [
{
"name": "create_api_credential",
      "description": "Activate API credential.",
      "method": "POST",
"path": "/api/web/namespaces/{namespace}/activate/api_credentials",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET credential object with a given name.",
      "title": "Get credential request",
      "x-displayname": "GET Credential.",
      "x-ves-proto-message": "ves.io.schema.api_credential.GetRequest",
      "properties": {
"name": {
"type": "string",
"description": "Name of API credential.",
      "title": "Credential name",
      "x-displayname": "Name",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "GET credential object with a given name.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_credentialGetRequest",
      "required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_credentialGetRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for api_credentialGetRequest"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of API credential.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "boolean",
"description": "Result status flag."
}
]
},
{
"name": "list_api_credentials",
      "description": "List API Credentials.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/api_credentials",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of credential items."
      }
]
},
{
"name": "get_api_credential",
      "description": "GET API Credentials.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/api_credentials/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "object",
"type": "object",
"description": ""
}
]
}
]
},
	"api-definitions": {
"name": "api-definitions",
      "displayName": "Api Definitions",
      "operations": [
{
"name": "create_api_definition",
      "description": "Create API Definition.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_definitions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of api_definition",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.api_definition.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/viewsapi_definitionCreateSpecType"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "API definition for documenting and protecting HTTP APIs",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: api_definition\nmetadata:\n  name: example-api\n  namespace: default\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-api\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-api",
      "namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "API definition for documenting and protecting HTTP APIs"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create API Definition.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_inventory_exclusion_list": {
      "type": "array",
"description": "List of API Endpoints excluded from the API Inventory.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_inventory_inclusion_list": {
      "type": "array",
"description": "List of API Endpoints included in the API Inventory.\nTypically, discovered API endpoints are added to the API Inventory using this list.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mixed_schema_origin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.non_api_endpoints": {
      "type": "array",
"description": "List of Non-API Endpoints.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.strict_schema_origin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.swagger_specs": {
"type": "array",
"description": "URLs of versioned OpenAPI files uploaded through Web App & API Protection > Files > Swagger Files. The 512-byte item limit is a URL-length limit; inline string:/// OpenAPI content is rejected and does not create an API-definition object.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.schema_updates_strategy": [
"mixed_schema_origin",
"strict_schema_origin"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_api_definition",
      "description": "Replace API Definition.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a api_definition",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.api_definition.ReplaceRequest",
      "properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsapi_definitionReplaceSpecType"
      }
],
"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": "API definition for documenting and protecting HTTP APIs",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: api_definition\nmetadata:\n  name: example-api\n  namespace: default\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-api\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-api",
      "namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "API definition for documenting and protecting HTTP APIs"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace API Definition.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_inventory_exclusion_list": {
      "type": "array",
"description": "List of API Endpoints excluded from the API Inventory.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_inventory_inclusion_list": {
      "type": "array",
"description": "List of API Endpoints included in the API Inventory.\nTypically, discovered API endpoints are added to the API Inventory using this list.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mixed_schema_origin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.non_api_endpoints": {
      "type": "array",
"description": "List of Non-API Endpoints.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.strict_schema_origin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.swagger_specs": {
"type": "array",
"description": "URLs of versioned OpenAPI files uploaded through Web App & API Protection > Files > Swagger Files. The 512-byte item limit is a URL-length limit; inline string:/// OpenAPI content is rejected and does not create an API-definition object.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.schema_updates_strategy": [
"mixed_schema_origin",
"strict_schema_origin"
]
}
},
{
"name": "list_api_definitions",
      "description": "List API Definition.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_definitions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_api_definition",
      "description": "DELETE API Definition.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a api_definition",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.api_definition.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_definitionDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_definitionDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      }
},
{
"name": "get_api_definition",
      "description": "GET API Definition.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"api-definitions-assign": {
"name": "api-definitions-assign",
      "displayName": "Api Definitions Assign",
      "operations": [
{
"name": "create_api_definitions_assign",
      "description": "Assign API Definition.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/api_definitions/assign",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request form for Assign API Definition.",
      "title": "Assign API Definition Request",
      "x-displayname": "Assign API Definition Request.",
      "x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.AssignAPIDefinitionReq",
      "properties": {
"api_definition": {
      "allOf": [
{
"$ref": "#/components/schemas/schemaviewsObjectRefType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"create_if_not_exists": {
"type": "boolean",
"description": "Create an empty API Definition object, if not exists.",
      "title": "Create if not exists",
"format": "boolean",
"x-displayname": "Create if not exists.",
"x-f5xc-description-short": "Create an empty API Definition object, if not exists.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the HTTP Load Balancer.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the HTTP Load Balancer.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for http_loadbalancerAssignAPIDefinitionReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for http_loadbalancerAssignAPIDefinitionReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for http_loadbalancerAssignAPIDefinitionReq"
      },
"fieldMetadata": {
"api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_definition.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"api_definition.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_definition.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"create_if_not_exists": {
"type": "boolean",
"description": "Create an empty API Definition object, if not exists.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the HTTP Load Balancer.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the HTTP Load Balancer.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"api-definitions-available": {
"name": "api-definitions-available",
      "displayName": "Api Definitions Available",
      "operations": [
{
"name": "list_api_definitions_available",
      "description": "List Available API Definitions.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/api_definitions/available",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"available_api_definitions": {
      "type": "array"
}
}
},
"responseSummary": [
{
"field": "available_api_definitions",
      "type": "array",
"description": "The list of references to available API Definition objects."
      }
]
}
]
},
	"api-definitions-without-shared": {
"name": "api-definitions-without-shared",
      "displayName": "Api Definitions Without Shared",
      "operations": [
{
"name": "list_api_definitions_without_shared",
      "description": "List Available API Definitions.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_definitions_without_shared",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"available_api_definitions": {
      "type": "array"
}
}
},
"responseSummary": [
{
"field": "available_api_definitions",
      "type": "array",
"description": "The list of references to available API Definition objects."
      }
]
}
]
},
	"api-discoverys": {
"name": "api-discoverys",
      "displayName": "Api Discoverys",
      "operations": [
{
"name": "create_api_discovery",
      "description": "Create API Discovery.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_discoverys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of api_discovery",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_discovery.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/api_discoveryCreateSpecType"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "API discovery configuration for automatic API endpoint detection",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.user_defined_api_discovery_policy"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: api_discovery\nmetadata:\n  name: example-discovery\n  namespace: default\nspec:\n  user_defined_api_discovery_policy: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-discovery\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"user_defined_api_discovery_policy\": {}\n  }\n}\n"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-discovery",
"namespace": "default"
},
"spec": {
"user_defined_api_discovery_policy": {}
      }
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.user_defined_api_discovery_policy"
      ],
"description": "API discovery configuration for automatic API endpoint detection"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create API discovery creates a new object in the storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_auth_types": {
      "type": "array",
"description": "Select your custom authentication types to be detected in the API discovery.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 10,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy": {
      "type": "object",
"description": "Rules are evaluated sequentially, top to bottom. If no rules are added, all traffic will be discovered or ignored based on the selection in the 'Default Behaviour of the Rule Set' field.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy.discovery_rules": {
      "type": "array",
"description": "Define rules to include or exclude endpoints by path, domain, or header. Rules run top to bottom; unmatched endpoints follow the default action.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy.exclusive": {
      "type": "object",
"description": "Configuration for exclusion action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy.inclusive": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.user_defined_api_discovery_policy.default_behavior_choice": [
      "exclusive",
"inclusive"
],
"spec.user_defined_api_discovery_policy.exclusive.action_choice": [
      "archive",
"ignore"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_api_discovery",
      "description": "Replace API Discovery.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/api_discoverys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a api_discovery",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_discovery.ReplaceRequest",
      "properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/api_discoveryReplaceSpecType"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "API discovery configuration for automatic API endpoint detection",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.user_defined_api_discovery_policy"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: api_discovery\nmetadata:\n  name: example-discovery\n  namespace: default\nspec:\n  user_defined_api_discovery_policy: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-discovery\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"user_defined_api_discovery_policy\": {}\n  }\n}\n"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-discovery",
"namespace": "default"
},
"spec": {
"user_defined_api_discovery_policy": {}
      }
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.user_defined_api_discovery_policy"
      ],
"description": "API discovery configuration for automatic API endpoint detection"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace api_discovery replaces an existing object in the storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_auth_types": {
      "type": "array",
"description": "Select your custom authentication types to be detected in the API discovery.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 10,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy": {
      "type": "object",
"description": "Rules are evaluated sequentially, top to bottom. If no rules are added, all traffic will be discovered or ignored based on the selection in the 'Default Behaviour of the Rule Set' field.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy.discovery_rules": {
      "type": "array",
"description": "Define rules to include or exclude endpoints by path, domain, or header. Rules run top to bottom; unmatched endpoints follow the default action.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy.exclusive": {
      "type": "object",
"description": "Configuration for exclusion action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_defined_api_discovery_policy.inclusive": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.user_defined_api_discovery_policy.default_behavior_choice": [
      "exclusive",
"inclusive"
],
"spec.user_defined_api_discovery_policy.exclusive.action_choice": [
      "archive",
"ignore"
]
}
},
{
"name": "list_api_discoverys",
      "description": "List API Discovery.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_discoverys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_api_discovery",
      "description": "DELETE API Discovery.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/api_discoverys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a api_discovery",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_discovery.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_discoveryDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_discoveryDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      }
},
{
"name": "get_api_discovery",
      "description": "GET API Discovery.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_discoverys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"api-endpoint": {
"name": "api-endpoint",
      "displayName": "Api Endpoint",
      "operations": [
{
"name": "create_api_endpoint",
      "description": "GET API Endpoint.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for GET API endpoint API.",
      "title": "API endpoint GET request Per Virtual Host",
      "x-displayname": "API Endpoint Request per Virtual Host.",
      "x-ves-proto-message": "ves.io.schema.virtual_host.APIEndpointReq",
      "properties": {
"api_endpoint_info_request": {
      "type": "array",
"description": "List of additional things that needs to be sent as part of the request.",
"title": "Api Endpoint Info Request",
      "items": {
"$ref": "#/components/schemas/app_typeApiEndpointInfoRequest"
      },
"x-displayname": "API Endpoint Info Request.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "List of additional things that needs to be sent as part of the request.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"collapsed_url": {
"type": "string",
"description": "Requested API endPoint for API URL.",
      "title": "API URL",
      "x-displayname": "API URL",
      "x-ves-example": "API/v1/user_id/DYN/vehicle_id/DYN.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "api/v1/user_id/DYN/vehicle_id/DYN",
      "x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"domains": {
"type": "array",
"description": "List of domains that needs to be sent as part of the request\nOptional filter by domains. If absent, all domains are considered.",
"title": "List of Domain",
"maxItems": 5,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"x-displayname": "List of Domain.",
"x-ves-example": "www.example.com.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.items.string.max_len": "256",
"ves.io.schema.rules.repeated.items.string.min_len": "1",
"ves.io.schema.rules.repeated.items.string.vh_domain_or_ip": "true",
"ves.io.schema.rules.repeated.max_items": "5",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "www.example.com",
"x-validation-rules": {
"ves.io.schema.rules.repeated.items.string.max_len": "256",
"ves.io.schema.rules.repeated.items.string.min_len": "1",
"ves.io.schema.rules.repeated.items.string.vh_domain_or_ip": "true",
"ves.io.schema.rules.repeated.max_items": "5",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "List of domains that needs to be sent as part of the request Optional filter by domains.",
"x-f5xc-description-medium": "List of domains that needs to be sent as part of the request Optional filter by domains. If absent, all domains are considered.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Requested API endPoint for method.",
      "title": "Method of current API URL",
      "x-displayname": "Method",
"x-ves-example": "GET",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "GET",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostAPIEndpointReq",
      "required_fields": [
"collapsed_url",
"method"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostAPIEndpointReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  collapsed_url: value\n  method: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"collapsed_url\": \"value\",\n    \"method\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"collapsed_url": "value",
"method": "value"
}
},
"requiredFields": [
"collapsed_url",
"method"
],
"description": "Minimum configuration for virtual_hostAPIEndpointReq"
      },
"fieldMetadata": {
"api_endpoint_info_request": {
      "type": "array",
"description": "List of additional things that needs to be sent as part of the request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"collapsed_url": {
"type": "string",
"description": "Requested API endPoint for API URL.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"domains": {
"type": "array",
"description": "List of domains that needs to be sent as part of the request\nOptional filter by domains. If absent, all domains are considered.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Requested API endPoint for method.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiep",
      "type": "object",
"description": ""
}
]
}
]
},
	"api-endpoint-learnt-schema": {
"name": "api-endpoint-learnt-schema",
      "displayName": "Api Endpoint Learnt Schema",
      "operations": [
{
"name": "create_api_endpoint_learnt_schema",
      "description": "GET Learnt Schema per API endpoint.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoint/learnt_schema",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Shape of request to GET learnt schema request for a given API endpoint.",
      "title": "API endpoint Learnt Schema request",
      "x-displayname": "Learnt Schema Request.",
"x-ves-proto-message": "ves.io.schema.app_type.APIEndpointLearntSchemaReq",
      "properties": {
"api_endpoint_info_request": {
      "type": "array",
"description": "List of additional things that needs to be sent as part of the request.",
"title": "Api Endpoint Info Request",
      "items": {
"$ref": "#/components/schemas/app_typeApiEndpointInfoRequest"
      },
"x-displayname": "API Endpoint Info Request.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "List of additional things that needs to be sent as part of the request.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"title": "App Type",
"x-displayname": "App Type",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"collapsed_url": {
"type": "string",
"description": "API endpoint for which PDFs are requested.",
      "title": "Discovered API URL",
      "x-displayname": "API URL",
      "x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "API endpoint for which PDFs are requested.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Method of API endpoint for which PDFs are requested.",
      "title": "Method of current API URL",
      "x-displayname": "Method",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Method of API endpoint for which PDFs are requested.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Shape of request to GET learnt schema request for a given API endpoint.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_typeAPIEndpointLearntSchemaReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeAPIEndpointLearntSchemaReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {
"api_specs": {
      "type": "object"
},
"inventory_openapi_spec": {
      "type": "string"
},
"sensitive_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeAPIEndpointLearntSchemaReq"
      },
"fieldMetadata": {
"api_endpoint_info_request": {
      "type": "array",
"description": "List of additional things that needs to be sent as part of the request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"collapsed_url": {
"type": "string",
"description": "API endpoint for which PDFs are requested.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Method of API endpoint for which PDFs are requested.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "api_specs",
      "type": "object",
"description": "Discovered API Specifications based on API type for eg, OpenAPI or GraphQL schema for API endpoint."
      },
{
"field": "discovered_schema",
"type": "object",
"description": ""
},
{
"field": "inventory_openapi_spec",
      "type": "string",
"description": "Inventory OpenAPI spec for request API endpoint."
      },
{
"field": "pdf_info",
"type": "object",
"description": ""
},
{
"field": "sensitive_data",
"type": "array",
"description": "List of sensitive data for request API endpoint."
      }
]
},
{
"name": "list_api_endpoint_learnt_schema",
      "description": "GET GET Learnt Schema per API endpoint.",
      "method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/learnt_schema",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "collapsed_url",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "method",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "domains",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "api_endpoint_info_request",
      "in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"api_specs": {
      "type": "object"
},
"inventory_openapi_spec": {
      "type": "string"
},
"sensitive_data": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "api_specs",
      "type": "object",
"description": "Discovered API Specifications based on API type for eg, OpenAPI or GraphQL schema for API endpoint."
      },
{
"field": "authentication",
      "type": "object",
"description": ""
},
{
"field": "discovered_schema",
"type": "object",
"description": ""
},
{
"field": "inventory_openapi_spec",
      "type": "string",
"description": "Inventory OpenAPI spec for request API endpoint."
      },
{
"field": "pdf_info",
"type": "object",
"description": ""
},
{
"field": "sensitive_data",
"type": "array",
"description": "List of sensitive data for request API endpoint."
      }
]
}
]
},
	"api-endpoint-pdf": {
"name": "api-endpoint-pdf",
      "displayName": "Api Endpoint Pdf",
      "operations": [
{
"name": "list_api_endpoint_pdf",
      "description": "GET PDF",
"method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoint/pdf",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "collapsed_url",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "method",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "pdf_info",
"type": "object",
"description": ""
}
]
}
]
},
	"api-endpoint-protection-suggestion": {
"name": "api-endpoint-protection-suggestion",
      "displayName": "Api Endpoint Protection Suggestion",
      "operations": [
{
"name": "create_api_endpoint_protection_suggestion",
      "description": "Suggest API endpoint protection rule.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/api_endpoint_protection/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested API endpoint protection rule for a given path.",
      "title": "GetSuggestedAPIEndpointProtectionRuleReq",
      "x-displayname": "GET Suggested API endpoint protection Rule Request.",
      "x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedAPIEndpointProtectionRuleReq",
      "properties": {
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this API endpoint protection rule applied.",
      "title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this API endpoint protection rule applied.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the API endpoint protection to.",
      "title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-description-short": "Path to apply the API endpoint protection to.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested API endpoint protection rule for a given path.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedAPIEndpointProtectionRuleReq",
      "required_fields": [
"path"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedAPIEndpointProtectionRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  path: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"path\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"path": "value"
}
},
"requiredFields": [
"path"
],
"description": "Minimum configuration for app_securityGetSuggestedAPIEndpointProtectionRuleReq"
      },
"fieldMetadata": {
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this API endpoint protection rule applied.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the API endpoint protection to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"api-endpoint-sources-openapi-schema": {
"name": "api-endpoint-sources-openapi-schema",
      "displayName": "Api Endpoint Sources Openapi Schema",
      "operations": [
{
"name": "list_api_endpoint_sources_openapi_schema",
      "description": "GET relevant source OpenApi schema per API endpoint.",
      "method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/sources_openapi_schema",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "discovery_source_types",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"api_specs": {
      "type": "object"
}
}
},
"responseSummary": [
{
"field": "api_specs",
      "type": "object",
"description": "Discovered API Specifications based on discovery Source."
      }
]
}
]
},
	"api-endpoint-unmerge-sources-openapi-schema": {
"name": "api-endpoint-unmerge-sources-openapi-schema",
      "displayName": "Api Endpoint Unmerge Sources Openapi Schema",
      "operations": [
{
"name": "create_api_endpoint_unmerge_sources_openapi_schema",
      "description": "Unmerge Source from API Endpoint.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoint/unmerge_sources_openapi_schema",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Unmerge Source from endpoint.",
"title": "Unmerge certain endpoint source",
"x-displayname": "Unmerge Source from endpoint.",
"x-ves-proto-message": "ves.io.schema.virtual_host.UnmergeAPIEPSourceOpenApiSchemaReq",
      "properties": {
"discovery_source_type": {
"allOf": [
{
"$ref": "#/components/schemas/virtual_hostAPIEPDiscoverySource"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Endpoint ID.",
"title": "id",
"x-displayname": "Endpoint ID.",
"x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostUnmergeAPIEPSourceOpenApiSchemaReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostUnmergeAPIEPSourceOpenApiSchemaReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostUnmergeAPIEPSourceOpenApiSchemaReq"
      },
"fieldMetadata": {
"discovery_source_type": {
"type": "string",
"description": "API Endpoint Discovery Source\n\nMerging all source types to one spec\nDiscovery spec from traffic data\nDiscovery spec from crawler engine\nDiscovery spec from code scan.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MERGED"
},
"id": {
"type": "string",
"description": "Endpoint ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"api-endpoints": {
"name": "api-endpoints",
      "displayName": "Api Endpoints",
      "operations": [
{
"name": "list_api_endpoints",
      "description": "GET API endpoints.",
      "method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoints",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "api_endpoint_info_request",
      "in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"apiep_list": {
      "type": "array"
}
}
},
"responseSummary": [
{
"field": "apiep_list",
      "type": "array",
"description": "List of API endpoints discovered."
      }
]
},
{
"name": "create_api_endpoint_api_endpoints",
      "description": "GET API Endpoints.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for GET API Endpoints For Groups.",
      "title": "Get API Endpoints For Groups Request",
      "x-displayname": "GET API Endpoints For Groups.",
      "x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.GetAPIEndpointsForGroupsReq",
      "properties": {
"name": {
"type": "string",
"description": "HTTP LoadBalancer for the current request.",
"title": "Http LoadBalancer Name",
"x-displayname": "HTTP LoadBalancer Name.",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "HTTP LoadBalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the HTTP LoadBalancer for the current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the HTTP LoadBalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for GET API Endpoints For Groups.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for http_loadbalancerGetAPIEndpointsForGroupsReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for http_loadbalancerGetAPIEndpointsForGroupsReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"api_endpoints": {
      "type": "array"
},
"apieps_timestamp": {
      "type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for http_loadbalancerGetAPIEndpointsForGroupsReq"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "HTTP LoadBalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the HTTP LoadBalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "api_endpoints",
      "type": "array",
"description": "A list of API endpoints associated with the HTTP Loadbalancer."
      },
{
"field": "apieps_timestamp",
      "type": "string",
"description": "The API endpoints timestamp indicates most recent update of API endpoints happened\nThe API Discovery periodically updates the API endpoints list based on application's traffic."
      }
]
}
]
},
	"api-endpoints-all-ns-stats": {
"name": "api-endpoints-all-ns-stats",
      "displayName": "Api Endpoints All Ns Stats",
      "operations": [
{
"name": "create_api_endpoints_all_ns_stat",
      "description": "GET API Endpoints Stats for All Namespaces.",
      "method": "POST",
"path": "/api/ml/data/namespaces/system/api_endpoints/all_ns_stats",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request shape for GET API Endpoints Stats All Namespaces.",
      "title": "Api Endpoints stats all namespaces request",
      "x-displayname": "API Endpoints Stats All Namespaces Request.",
      "x-ves-proto-message": "ves.io.schema.namespace.ApiEndpointsStatsAllNSReq",
      "properties": {
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for GET API Endpoints Stats All Namespaces.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceApiEndpointsStatsAllNSReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceApiEndpointsStatsAllNSReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"discovered": {
"type": "integer"
},
"inventory": {
"type": "integer"
},
"pii_detected": {
"type": "integer"
},
"shadow": {
"type": "integer"
},
"total_endpoints": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceApiEndpointsStatsAllNSReq"
      },
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "discovered",
"type": "integer",
"description": "Number of endpoints that categorized as discover."
},
{
"field": "inventory",
"type": "integer",
"description": "Number of endpoints that categorized as inventory."
},
{
"field": "pii_detected",
"type": "integer",
"description": "Number of endpoints that detected with pii."
},
{
"field": "shadow",
"type": "integer",
"description": "Number of endpoints that categorized as shadow."
},
{
"field": "total_endpoints",
"type": "integer",
"description": "Total endpoints."
}
]
}
]
},
	"api-endpoints-stats": {
"name": "api-endpoints-stats",
      "displayName": "Api Endpoints Stats",
      "operations": [
{
"name": "list_api_endpoints_stats",
      "description": "GET API Endpoints Stats for Virtual Host.",
      "method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/stats",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"discovered": {
"type": "integer"
},
"inventory": {
"type": "integer"
},
"pii_detected": {
"type": "integer"
},
"shadow": {
"type": "integer"
},
"total_endpoints": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "discovered",
"type": "integer",
"description": "Number of endpoints that categorized as discover."
},
{
"field": "inventory",
"type": "integer",
"description": "Number of endpoints that categorized as inventory."
},
{
"field": "pii_detected",
"type": "integer",
"description": "Number of endpoints that detected with pii."
},
{
"field": "shadow",
"type": "integer",
"description": "Number of endpoints that categorized as shadow."
},
{
"field": "total_endpoints",
"type": "integer",
"description": "Total endpoints."
}
]
}
]
},
	"api-endpoints-summary-calls-by-response-code": {
"name": "api-endpoints-summary-calls-by-response-code",
      "displayName": "Api Endpoints Summary Calls By Response Code",
      "operations": [
{
"name": "create_api_endpoints_summary_calls_by_response_code",
      "description": "GET Total API Calls for Virtual Host.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/summary/calls_by_response_code",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request model for GetAPICallSummary API.",
      "title": "GetAPICallSummaryReq",
      "x-displayname": "GET API Call Summary Request.",
      "x-ves-proto-message": "ves.io.schema.virtual_host.GetAPICallSummaryReq",
      "properties": {
"apiep_summary_filter": {
      "allOf": [
{
"$ref": "#/components/schemas/virtual_hostAPIEPSummaryFilter"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request model for GetAPICallSummary API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostGetAPICallSummaryReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostGetAPICallSummaryReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"request_count_per_rsp_code": {
"type": "array"
},
"total_calls": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostGetAPICallSummaryReq"
      },
"fieldMetadata": {
"apiep_summary_filter": {
      "type": "object",
"description": "Filter object for summary block.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.apiep_category": {
      "type": "array",
"description": "Category of API endpoints. Can be DISCOVERED, INVENTORY or SHADOW API.\nOptional filter by api_category. If absent, endpoints of all categories are considered.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.domains": {
      "type": "array",
"description": "List of domains for which top API endpoints summary should be returned.\nOptional filter by domains. If absent, endpoints for all domains are considered.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.end_time": {
      "type": "string",
"description": "Format: unix_timestamp|RFC 3339\nFilters the APIEPs with access time < end_time.\nOptional: If not specified, then the end_time will be evaluated to start_time+2h\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.start_time": {
      "type": "string",
"description": "Format: unix_timestamp|RFC 3339\nFilters the APIEPs with access time >= start_time.\nOptional: If not specified, then the start_time will be evaluated to end_time-2h\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "request_count_per_rsp_code",
"type": "array",
"description": "Number of API calls for each category of response."
      },
{
"field": "total_calls",
"type": "string",
"description": "Total API calls."
      }
]
}
]
},
	"api-endpoints-summary-top-active": {
"name": "api-endpoints-summary-top-active",
      "displayName": "Api Endpoints Summary Top Active",
      "operations": [
{
"name": "create_api_endpoints_summary_top_active",
      "description": "GET Top APIs Endpoints for Virtual Host.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/summary/top_active",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request model for GetTopAPIEndpointsReq API.",
      "title": "Top attacked/active API endpoints request per virtual host",
      "x-displayname": "Top Attacked/Active API Endpoints per Virtual Host.",
      "x-ves-proto-message": "ves.io.schema.virtual_host.GetTopAPIEndpointsReq",
      "properties": {
"apiep_summary_filter": {
      "allOf": [
{
"$ref": "#/components/schemas/virtual_hostAPIEPSummaryFilter"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"top_by_metric": {
"allOf": [
{
"$ref": "#/components/schemas/virtual_hostAPIEPActivityMetricType"
      }
],
"x-f5xc-description-short": "Configuration parameter for top by metric.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"topk": {
"type": "integer",
"description": "Number of top API endpoints to return in the response.",
      "title": "topk",
"format": "int64",
"x-displayname": "Number of Top API Endpoints.",
      "x-ves-example": "5",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "10"
},
"x-f5xc-example": "5",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "10"
},
"x-f5xc-description-short": "Number of top API endpoints to return in the response.",
      "x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 10,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request model for GetTopAPIEndpointsReq API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostGetTopAPIEndpointsReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostGetTopAPIEndpointsReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"top_apieps": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostGetTopAPIEndpointsReq"
      },
"fieldMetadata": {
"apiep_summary_filter": {
      "type": "object",
"description": "Filter object for summary block.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.apiep_category": {
      "type": "array",
"description": "Category of API endpoints. Can be DISCOVERED, INVENTORY or SHADOW API.\nOptional filter by api_category. If absent, endpoints of all categories are considered.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.domains": {
      "type": "array",
"description": "List of domains for which top API endpoints summary should be returned.\nOptional filter by domains. If absent, endpoints for all domains are considered.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.end_time": {
      "type": "string",
"description": "Format: unix_timestamp|RFC 3339\nFilters the APIEPs with access time < end_time.\nOptional: If not specified, then the end_time will be evaluated to start_time+2h\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"apiep_summary_filter.start_time": {
      "type": "string",
"description": "Format: unix_timestamp|RFC 3339\nFilters the APIEPs with access time >= start_time.\nOptional: If not specified, then the start_time will be evaluated to end_time-2h\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"top_by_metric": {
"type": "string",
"description": "Activity metric calculation type per API Endpoint\n\nIf specified, API returns top attacked APIEPs summary by sec_event percentage for given virtual host.\nThe percentage is calculated as sec_events_percentage(apiep) = #sec-events(apiep)/#requests(apiep) * 100\nIf specified, API returns top active APIEPs summary by request ratio for given virtual host.\nThe percentage is calculated as request_percentage(apiep) = #requests(apiep)/#requests(all apiep) * 100.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ACTIVITY_METRIC_TYPE_SEC_EVENTS_PERCENTAGE"
},
"topk": {
"type": "integer",
"description": "Number of top API endpoints to return in the response.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 10,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "top_apieps",
      "type": "array",
"description": "Top Attacked API endpoints."
      }
]
}
]
},
	"api-endpoints-summary-top-sensitive-data": {
"name": "api-endpoints-summary-top-sensitive-data",
      "displayName": "Api Endpoints Summary Top Sensitive Data",
      "operations": [
{
"name": "create_api_endpoints_summary_top_sensitive_data",
      "description": "GET Sensitive Data Summary for Virtual Host.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/api_endpoints/summary/top_sensitive_data",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request model for GetTopSensitiveDataReq API.",
      "title": "GetTopSensitiveDataReq",
"x-displayname": "GET Top Sensitive Data Request Object.",
"x-ves-proto-message": "ves.io.schema.virtual_host.GetTopSensitiveDataReq",
"properties": {
"apiep_category": {
      "type": "array",
"description": "Category of API endpoints. Can be DISCOVERED, INVENTORY or SHADOW API.",
      "title": "APIEP Category",
      "items": {
"$ref": "#/components/schemas/app_typeAPIEPCategory"
      },
"x-displayname": "APIEP Category.",
      "x-ves-example": "DISCOVERED.",
"x-f5xc-example": "DISCOVERED",
"x-f5xc-description-short": "Category of API endpoints. Can be DISCOVERED, INVENTORY or SHADOW API.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domains": {
"type": "array",
"description": "List of domains for which top API endpoints summary should be returned.\nOptional filter by domains. If absent, endpoints for all domains are considered.",
      "title": "List of Domain",
"maxItems": 5,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"x-displayname": "List of Domain.",
"x-ves-example": "www.example.com.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.items.string.max_len": "256",
"ves.io.schema.rules.repeated.items.string.min_len": "1",
"ves.io.schema.rules.repeated.items.string.vh_domain_or_ip": "true",
"ves.io.schema.rules.repeated.max_items": "5",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "www.example.com",
"x-validation-rules": {
"ves.io.schema.rules.repeated.items.string.max_len": "256",
"ves.io.schema.rules.repeated.items.string.min_len": "1",
"ves.io.schema.rules.repeated.items.string.vh_domain_or_ip": "true",
"ves.io.schema.rules.repeated.max_items": "5",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "List of domains for which top API endpoints summary should be returned. Optional filter by domains.",
      "x-f5xc-description-medium": "List of domains for which top API endpoints summary should be returned. Optional filter by domains. If absent, endpoints for all domains are considered.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"topk": {
"type": "integer",
"description": "Number of top API endpoints to return in the response.",
      "title": "topk",
"format": "int64",
"x-displayname": "Number of Top API Endpoints.",
      "x-ves-example": "5",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "10"
},
"x-f5xc-example": "5",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "10"
},
"x-f5xc-description-short": "Number of top API endpoints to return in the response.",
      "x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 10,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request model for GetTopSensitiveDataReq API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostGetTopSensitiveDataReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostGetTopSensitiveDataReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"top_sensitive_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostGetTopSensitiveDataReq"
},
"fieldMetadata": {
"apiep_category": {
      "type": "array",
"description": "Category of API endpoints. Can be DISCOVERED, INVENTORY or SHADOW API.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domains": {
"type": "array",
"description": "List of domains for which top API endpoints summary should be returned.\nOptional filter by domains. If absent, endpoints for all domains are considered.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"topk": {
"type": "integer",
"description": "Number of top API endpoints to return in the response.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 10,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "top_sensitive_data",
"type": "array",
"description": "Top k (max 10) sensitive data types with highest APIs count."
      }
]
}
]
},
	"api-endpoints-swagger-spec": {
"name": "api-endpoints-swagger-spec",
      "displayName": "Api Endpoints Swagger Spec",
      "operations": [
{
"name": "list_api_endpoints_swagger_spec",
      "description": "GET Swagger Spec for App Type.",
"method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoints/swagger_spec",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"api-group-elements": {
"name": "api-group-elements",
      "displayName": "Api Group Elements",
      "operations": [
{
"name": "list_api_group_elements",
      "description": "List API Group Element.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/api_group_elements",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_api_group_element",
      "description": "GET API Group Element.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/api_group_elements/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"api-groups": {
"name": "api-groups",
      "displayName": "Api Groups",
      "operations": [
{
"name": "list_api_groups",
      "description": "List API Group.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/api_groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_api_group",
      "description": "GET API Group.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/api_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"api-inventory-api-endpoints-get-schema-updates": {
"name": "api-inventory-api-endpoints-get-schema-updates",
      "displayName": "Api Inventory Api Endpoints Get Schema Updates",
      "operations": [
{
"name": "create_api_inventory_api_endpoints_get_schema_update",
      "description": "GET API Endpoints Schema Updates.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_inventory/api_endpoints/get_schema_updates",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for GET API Endpoints Schema Updates.",
      "title": "Get API Endpoints Schema Updates Request",
      "x-displayname": "GET API Endpoints Schema Updates Request.",
      "x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.GetAPIEndpointsSchemaUpdatesReq",
      "properties": {
"api_endpoints_filter": {
      "type": "array",
"description": "The list of discovered API endpoint to GET schema for.\nNOTE: if empty, then the all API endpoints with schema changes would be returned.",
      "title": "API Endpoints Filter",
      "maxItems": 100,
"items": {
"$ref": "#/components/schemas/viewsApiOperation"
      },
"x-displayname": "API Endpoints Filter.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "The list of discovered API endpoint to GET schema for.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the HTTP Loadbalancer for the current request.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "The name of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace of the HTTP Loadbalancer for the current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "The namespace of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query_type": {
"allOf": [
{
"$ref": "#/components/schemas/http_loadbalancerApiInventorySchemaQueryType"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request shape for GET API Endpoints Schema Updates.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for http_loadbalancerGetAPIEndpointsSchemaUpdatesReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for http_loadbalancerGetAPIEndpointsSchemaUpdatesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"api_endpoints_current_schemas": {
      "type": "array"
},
"api_endpoints_updated_schemas": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for http_loadbalancerGetAPIEndpointsSchemaUpdatesReq"
      },
"fieldMetadata": {
"api_endpoints_filter": {
      "type": "array",
"description": "The list of discovered API endpoint to GET schema for.\nNOTE: if empty, then the all API endpoints with schema changes would be returned.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query_type": {
"type": "string",
"description": "API Inventory Schema Query Type\n\n- API_INVENTORY_SCHEMA_FULL_RESPONSE: Full Response\n\n- API_INVENTORY_SCHEMA_CURRENT: Current Schema\n\n- API_INVENTORY_SCHEMA_UPDATED: Updated Schema.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "API_INVENTORY_SCHEMA_FULL_RESPONSE"
      }
},
"responseSummary": [
{
"field": "api_endpoints_current_schemas",
      "type": "array",
"description": "The list of discovered API endpoints with current schemas."
      },
{
"field": "api_endpoints_updated_schemas",
      "type": "array",
"description": "The list of API Inventory API endpoints with updated schemas."
      }
]
}
]
},
	"api-inventory-api-endpoints-update-schemas": {
"name": "api-inventory-api-endpoints-update-schemas",
      "displayName": "Api Inventory Api Endpoints Update Schemas",
      "operations": [
{
"name": "create_api_inventory_api_endpoints_update_schema",
      "description": "Update API Endpoints Schemas.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/http_loadbalancers/{name}/api_inventory/api_endpoints/update_schemas",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for Update API Endpoints Schemas.",
      "title": "Update API Endpoints Schemas Request",
      "x-displayname": "Update API Endpoints Schemas Request.",
      "x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.UpdateAPIEndpointsSchemasReq",
      "properties": {
"api_endpoints_schema_updates": {
      "type": "array",
"description": "The list of API Inventory API endpoints schema updates.",
      "title": "API Endpoints Schema Updates",
      "minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/viewsApiEndpointWithSchema"
      },
"x-displayname": "API Endpoints Schema Updates.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "The list of API Inventory API endpoints schema updates.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the HTTP Loadbalancer for the current request.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "The name of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace of the HTTP Loadbalancer for the current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "The namespace of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for Update API Endpoints Schemas.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for http_loadbalancerUpdateAPIEndpointsSchemasReq",
      "required_fields": [
"api_endpoints_schema_updates"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for http_loadbalancerUpdateAPIEndpointsSchemasReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  api_endpoints_schema_updates: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"api_endpoints_schema_updates\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"updated_api_endpoints": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"api_endpoints_schema_updates": "value"
      }
},
"requiredFields": [
"api_endpoints_schema_updates"
      ],
"description": "Minimum configuration for http_loadbalancerUpdateAPIEndpointsSchemasReq"
      },
"fieldMetadata": {
"api_endpoints_schema_updates": {
      "type": "array",
"description": "The list of API Inventory API endpoints schema updates.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace of the HTTP Loadbalancer for the current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "updated_api_endpoints",
      "type": "array",
"description": "The list of API endpoints which were successfully proceeded by the API Inventory request."
      }
]
}
]
},
	"api-testings": {
"name": "api-testings",
      "displayName": "Api Testings",
      "operations": [
{
"name": "create_api_testing",
      "description": "Create API Testing.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_testings",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of api_testing",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_testing.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/api_testingCreateSpecType"
      }
],
"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 api_testingCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_testingCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for api_testingCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_header_value": {
"type": "string",
"description": "Add x-F5-API-testing-identifier header value to prevent security flags on API testing traffic.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "Add and configure testing domains and credentials.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.every_day": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.every_month": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.every_week": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.frequency_choice": [
"every_day",
"every_month",
"every_week"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_api_testing",
      "description": "Replace API testing.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/api_testings/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a api_testing",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_testing.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/api_testingReplaceSpecType"
      }
],
"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 api_testingReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_testingReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for api_testingReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_header_value": {
"type": "string",
"description": "Add x-F5-API-testing-identifier header value to prevent security flags on API testing traffic.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "Add and configure testing domains and credentials.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.every_day": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.every_month": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.every_week": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.frequency_choice": [
"every_day",
"every_month",
"every_week"
]
}
},
{
"name": "list_api_testings",
      "description": "List API Testing.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_testings",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_api_testing",
      "description": "DELETE API Testing.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/api_testings/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a api_testing",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.api_testing.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_testingDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_testingDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      }
},
{
"name": "get_api_testing",
      "description": "GET API testing.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/api_testings/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"app-api-groups": {
"name": "app-api-groups",
      "displayName": "App Api Groups",
      "operations": [
{
"name": "create_app_api_group",
      "description": "Create API Group.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/app_api_groups",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of app_api_group",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.app_api_group.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/viewsapp_api_groupCreateSpecType"
      }
],
"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 app_api_groupCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_api_groupCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_api_groupCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create app_api_group creates a new object in the storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bigip_virtual_server": {
"type": "object",
"description": "Set the scope of the API Group to a specific BIG-IP Virtual Server.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bigip_virtual_server.bigip_virtual_server": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cdn_loadbalancer": {
"type": "object",
"description": "Set the scope of the API Group to a specific CDN Loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cdn_loadbalancer.cdn_loadbalancer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.elements": {
"type": "array",
"description": "List of API group elements with methods and path regex for matching requests.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_loadbalancer": {
"type": "object",
"description": "Set the scope of the API Group to a specific HTTP Loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_loadbalancer.http_loadbalancer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.scope_choice": [
"bigip_virtual_server",
"cdn_loadbalancer",
"http_loadbalancer"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_app_api_group",
      "description": "Replace API Group.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/app_api_groups/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a app_api_group",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.app_api_group.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/viewsapp_api_groupReplaceSpecType"
      }
],
"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 app_api_groupReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_api_groupReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_api_groupReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace app_api_group replaces an existing object in the storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bigip_virtual_server": {
"type": "object",
"description": "Set the scope of the API Group to a specific BIG-IP Virtual Server.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bigip_virtual_server.bigip_virtual_server": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cdn_loadbalancer": {
"type": "object",
"description": "Set the scope of the API Group to a specific CDN Loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cdn_loadbalancer.cdn_loadbalancer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.elements": {
"type": "array",
"description": "List of API group elements with methods and path regex for matching requests.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_loadbalancer": {
"type": "object",
"description": "Set the scope of the API Group to a specific HTTP Loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_loadbalancer.http_loadbalancer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.scope_choice": [
"bigip_virtual_server",
"cdn_loadbalancer",
"http_loadbalancer"
]
}
},
{
"name": "list_app_api_groups",
      "description": "List App API Group.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/app_api_groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_app_api_group",
      "description": "DELETE App API Group.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/app_api_groups/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a app_api_group",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.app_api_group.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_api_groupDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_api_groupDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      }
},
{
"name": "get_app_api_group",
      "description": "GET API Group.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/app_api_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"app-firewall-all-ns-metrics": {
"name": "app-firewall-all-ns-metrics",
"displayName": "App Firewall All Ns Metrics",
"operations": [
{
"name": "create_app_firewall_all_ns_metric",
"description": "MetricsAllNamespaces.",
"method": "POST",
"path": "/api/data/namespaces/system/app_firewall/all_ns_metrics",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to GET the metrics for App Firewall.",
"title": "Metrics Request",
"x-displayname": "Metrics Request.",
"x-ves-proto-message": "ves.io.schema.app_firewall.MetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/schemaapp_firewallMetricType"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{NAMESPACE=\\\"example-namespace\"}",
"x-f5xc-example": "\"{NAMESPACE=\\\"example-namespace\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = : equal to != : not equal to =~ : regex match !~ : not regex match Optional: If not specified, metric...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/app_firewallMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"format": "boolean",
"x-displayname": "Trend calculation requested by the user.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the metrics for App Firewall.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_firewallMetricsRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_firewallMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for app_firewallMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series metric data for App Firewall."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"app-firewalls": {
"name": "app-firewalls",
"displayName": "App Firewalls",
"operations": [
{
"name": "create_app_firewall",
"description": "Create Application Firewall.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/app_firewalls",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of app_firewall",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.app_firewall.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/app_firewallCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Web Application Firewall (WAF) policy for protecting HTTP applications",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "enforcement_mode_choice",
"fields": [
"spec.monitoring",
"spec.blocking"
],
"reason": "Server default is monitoring (no blocking). Use blocking: {} for production WAF protection."
},
{
"name": "detection_setting_choice",
"fields": [
"spec.default_detection_settings",
"spec.detection_settings"
],
"reason": "Server applies default_detection_settings: {} when omitted"
},
{
"name": "allowed_response_codes_choice",
"fields": [
"spec.allow_all_response_codes",
"spec.allowed_response_codes"
],
"reason": "Server applies allow_all_response_codes: {} when omitted"
},
{
"name": "bot_protection_choice",
"fields": [
"spec.default_bot_setting",
"spec.bot_protection_setting"
],
"reason": "Server applies default_bot_setting: {} when omitted"
},
{
"name": "anonymization_setting",
"fields": [
"spec.default_anonymization",
"spec.custom_anonymization",
"spec.disable_anonymization"
],
"reason": "Server applies default_anonymization: {} when omitted"
},
{
"name": "blocking_page_choice",
"fields": [
"spec.use_default_blocking_page",
"spec.blocking_page"
],
"reason": "Server applies use_default_blocking_page: {} when omitted"
},
{
"name": "enhance_with_ai_choice",
"fields": [
"spec.disable_ai_enhancements",
"spec.enable_ai_enhancements"
],
"reason": "Server applies disable_ai_enhancements: {} when omitted"
}
],
"example_yaml": "apiVersion: v1\nkind: app_firewall\nmetadata:\n  name: default-waf\n  namespace: default\nspec:\n  blocking: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"default-waf\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"blocking\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "default-waf",
"namespace": "default"
},
"spec": {
"blocking": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Web Application Firewall (WAF) policy for protecting HTTP applications"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Application Firewall.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_response_codes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_response_codes": {
"type": "object",
"description": "List of HTTP response status codes that are allowed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_response_codes.response_code": {
"type": "array",
"description": "List of HTTP response status codes that are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 48,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.blocking": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocking_page": {
"type": "object",
"description": "Custom blocking response page body.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocking_page.blocking_page": {
"type": "string",
"description": "Define the content of the response page (e.g., an HTML document or a JSON object), use the\n{{request_id}} placeholder to provide users with a unique\nidentifier to be able to trace the blocked request in the logs.\nThe maximum allowed size of response body is 4096 bytes after base64 encoding,\nwhich would be about 3070 bytes in plain text.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 4096,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "content",
"note": "Must be a valid URI (uri_ref). API rejects inline HTML despite the description example.",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocking_page.response_code": {
"type": "string",
"description": "HTTP response status codes\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIm Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nURI Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\nMisdirected Request status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHTTP Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nNot Extended status code\nNetwork Authentication Required status code.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "EmptyStatusCode"
},
"spec.bot_protection_setting": {
"type": "object",
"description": "Configuration of WAF Bot Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_protection_setting.good_bot_action": {
"type": "string",
"description": "Action to be performed on the request\n\nLog and block\nLog only\nDisable detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
},
"spec.bot_protection_setting.malicious_bot_action": {
"type": "string",
"description": "Action to be performed on the request\n\nLog and block\nLog only\nDisable detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
},
"spec.bot_protection_setting.suspicious_bot_action": {
"type": "string",
"description": "Action to be performed on the request\n\nLog and block\nLog only\nDisable detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
},
"spec.custom_anonymization": {
"type": "object",
"description": "Anonymization settings which is a list of HTTP headers, parameters and cookies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_anonymization.anonymization_config": {
"type": "array",
"description": "List of HTTP headers, cookies and query parameters whose values will be masked.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.default_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_bot_setting": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_detection_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings": {
"type": "object",
"description": "Specifies detection settings to be used by WAF.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.bot_protection_setting": {
"type": "object",
"description": "Configuration of WAF Bot Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.default_bot_setting": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.default_violation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.disable_staging": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.disable_suppression": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.disable_threat_campaigns": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.enable_suppression": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.enable_threat_campaigns": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.signature_selection_setting": {
"type": "object",
"description": "Attack Signatures are patterns that identify attacks on a web application and its components.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.stage_new_and_updated_signatures": {
"type": "object",
"description": "Attack Signatures staging configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.stage_new_signatures": {
"type": "object",
"description": "Attack Signatures staging configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.violation_settings": {
"type": "object",
"description": "Specifies violation settings to be used by WAF.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.violations_view": {
"type": "array",
"description": "List of violation checks that are performed on HTTP request to ensure the requests are properly formatted, detection of evasion techniques and other violations.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_ai_enhancements": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ai_enhancements": {
"type": "object",
"description": "Actions complimented by the additional intelligence of the F5 AI Powered Risk-based analysis.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ai_enhancements.mitigate_high_medium_risk_action": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ai_enhancements.mitigate_high_risk_action": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.monitoring": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_blocking_page": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.allowed_response_codes_choice": [
"allow_all_response_codes",
"allowed_response_codes"
],
"spec.anonymization_setting": [
"custom_anonymization",
"default_anonymization",
"disable_anonymization"
],
"spec.blocking_page_choice": [
"blocking_page",
"use_default_blocking_page"
],
"spec.bot_protection_choice": [
"bot_protection_setting",
"default_bot_setting"
],
"spec.detection_setting_choice": [
"default_detection_settings",
"detection_settings"
],
"spec.enforcement_mode_choice": [
"blocking",
"monitoring"
],
"spec.enhance_with_ai_choice": [
"disable_ai_enhancements",
"enable_ai_enhancements"
],
"spec.detection_settings.bot_protection_choice": [
"bot_protection_setting",
"default_bot_setting"
],
"spec.detection_settings.false_positive_suppression": [
"disable_suppression",
"enable_suppression"
],
"spec.detection_settings.signatures_staging_settings": [
"disable_staging",
"stage_new_and_updated_signatures",
"stage_new_signatures"
],
"spec.detection_settings.threat_campaign_choice": [
"disable_threat_campaigns",
"enable_threat_campaigns"
],
"spec.detection_settings.violation_detection_setting": [
"default_violation_settings",
"violation_settings"
],
"spec.detection_settings.signature_selection_setting.attack_type_setting": [
"attack_type_settings",
"default_attack_type_settings"
],
"spec.detection_settings.signature_selection_setting.signature_selection_by_accuracy": [
"high_medium_accuracy_signatures",
"high_medium_low_accuracy_signatures",
"only_high_accuracy_signatures"
],
"spec.enable_ai_enhancements.risk_score_action_choice": [
"mitigate_high_medium_risk_action",
"mitigate_high_risk_action"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_app_firewall",
"description": "Replace Application Firewall.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/app_firewalls/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a app_firewall",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.app_firewall.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/app_firewallReplaceSpecType"
}
],
"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": "Web Application Firewall (WAF) policy for protecting HTTP applications",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "enforcement_mode_choice",
"fields": [
"spec.monitoring",
"spec.blocking"
],
"reason": "Server default is monitoring (no blocking). Use blocking: {} for production WAF protection."
},
{
"name": "detection_setting_choice",
"fields": [
"spec.default_detection_settings",
"spec.detection_settings"
],
"reason": "Server applies default_detection_settings: {} when omitted"
},
{
"name": "allowed_response_codes_choice",
"fields": [
"spec.allow_all_response_codes",
"spec.allowed_response_codes"
],
"reason": "Server applies allow_all_response_codes: {} when omitted"
},
{
"name": "bot_protection_choice",
"fields": [
"spec.default_bot_setting",
"spec.bot_protection_setting"
],
"reason": "Server applies default_bot_setting: {} when omitted"
},
{
"name": "anonymization_setting",
"fields": [
"spec.default_anonymization",
"spec.custom_anonymization",
"spec.disable_anonymization"
],
"reason": "Server applies default_anonymization: {} when omitted"
},
{
"name": "blocking_page_choice",
"fields": [
"spec.use_default_blocking_page",
"spec.blocking_page"
],
"reason": "Server applies use_default_blocking_page: {} when omitted"
},
{
"name": "enhance_with_ai_choice",
"fields": [
"spec.disable_ai_enhancements",
"spec.enable_ai_enhancements"
],
"reason": "Server applies disable_ai_enhancements: {} when omitted"
}
],
"example_yaml": "apiVersion: v1\nkind: app_firewall\nmetadata:\n  name: default-waf\n  namespace: default\nspec:\n  blocking: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"default-waf\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"blocking\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "default-waf",
"namespace": "default"
},
"spec": {
"blocking": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Web Application Firewall (WAF) policy for protecting HTTP applications"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Application Firewall.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_response_codes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_response_codes": {
"type": "object",
"description": "List of HTTP response status codes that are allowed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_response_codes.response_code": {
"type": "array",
"description": "List of HTTP response status codes that are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 48,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.blocking": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocking_page": {
"type": "object",
"description": "Custom blocking response page body.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocking_page.blocking_page": {
"type": "string",
"description": "Define the content of the response page (e.g., an HTML document or a JSON object), use the\n{{request_id}} placeholder to provide users with a unique\nidentifier to be able to trace the blocked request in the logs.\nThe maximum allowed size of response body is 4096 bytes after base64 encoding,\nwhich would be about 3070 bytes in plain text.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 4096,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "content",
"note": "Must be a valid URI (uri_ref). API rejects inline HTML despite the description example.",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocking_page.response_code": {
"type": "string",
"description": "HTTP response status codes\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIm Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nURI Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\nMisdirected Request status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHTTP Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nNot Extended status code\nNetwork Authentication Required status code.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "EmptyStatusCode"
},
"spec.bot_protection_setting": {
"type": "object",
"description": "Configuration of WAF Bot Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_protection_setting.good_bot_action": {
"type": "string",
"description": "Action to be performed on the request\n\nLog and block\nLog only\nDisable detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
},
"spec.bot_protection_setting.malicious_bot_action": {
"type": "string",
"description": "Action to be performed on the request\n\nLog and block\nLog only\nDisable detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
},
"spec.bot_protection_setting.suspicious_bot_action": {
"type": "string",
"description": "Action to be performed on the request\n\nLog and block\nLog only\nDisable detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
},
"spec.custom_anonymization": {
"type": "object",
"description": "Anonymization settings which is a list of HTTP headers, parameters and cookies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_anonymization.anonymization_config": {
"type": "array",
"description": "List of HTTP headers, cookies and query parameters whose values will be masked.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.default_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_bot_setting": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_detection_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings": {
"type": "object",
"description": "Specifies detection settings to be used by WAF.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.bot_protection_setting": {
"type": "object",
"description": "Configuration of WAF Bot Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.default_bot_setting": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.default_violation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.disable_staging": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.disable_suppression": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.disable_threat_campaigns": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.enable_suppression": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.enable_threat_campaigns": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.signature_selection_setting": {
"type": "object",
"description": "Attack Signatures are patterns that identify attacks on a web application and its components.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.stage_new_and_updated_signatures": {
"type": "object",
"description": "Attack Signatures staging configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.stage_new_signatures": {
"type": "object",
"description": "Attack Signatures staging configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.violation_settings": {
"type": "object",
"description": "Specifies violation settings to be used by WAF.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.detection_settings.violations_view": {
"type": "array",
"description": "List of violation checks that are performed on HTTP request to ensure the requests are properly formatted, detection of evasion techniques and other violations.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_ai_enhancements": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ai_enhancements": {
"type": "object",
"description": "Actions complimented by the additional intelligence of the F5 AI Powered Risk-based analysis.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ai_enhancements.mitigate_high_medium_risk_action": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ai_enhancements.mitigate_high_risk_action": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.monitoring": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_blocking_page": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.allowed_response_codes_choice": [
"allow_all_response_codes",
"allowed_response_codes"
],
"spec.anonymization_setting": [
"custom_anonymization",
"default_anonymization",
"disable_anonymization"
],
"spec.blocking_page_choice": [
"blocking_page",
"use_default_blocking_page"
],
"spec.bot_protection_choice": [
"bot_protection_setting",
"default_bot_setting"
],
"spec.detection_setting_choice": [
"default_detection_settings",
"detection_settings"
],
"spec.enforcement_mode_choice": [
"blocking",
"monitoring"
],
"spec.enhance_with_ai_choice": [
"disable_ai_enhancements",
"enable_ai_enhancements"
],
"spec.detection_settings.bot_protection_choice": [
"bot_protection_setting",
"default_bot_setting"
],
"spec.detection_settings.false_positive_suppression": [
"disable_suppression",
"enable_suppression"
],
"spec.detection_settings.signatures_staging_settings": [
"disable_staging",
"stage_new_and_updated_signatures",
"stage_new_signatures"
],
"spec.detection_settings.threat_campaign_choice": [
"disable_threat_campaigns",
"enable_threat_campaigns"
],
"spec.detection_settings.violation_detection_setting": [
"default_violation_settings",
"violation_settings"
],
"spec.detection_settings.signature_selection_setting.attack_type_setting": [
"attack_type_settings",
"default_attack_type_settings"
],
"spec.detection_settings.signature_selection_setting.signature_selection_by_accuracy": [
"high_medium_accuracy_signatures",
"high_medium_low_accuracy_signatures",
"only_high_accuracy_signatures"
],
"spec.enable_ai_enhancements.risk_score_action_choice": [
"mitigate_high_medium_risk_action",
"mitigate_high_risk_action"
]
}
},
{
"name": "list_app_firewalls",
"description": "List Application Firewall.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/app_firewalls",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_app_firewall",
"description": "DELETE Application Firewall.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/app_firewalls/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a app_firewall",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.app_firewall.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_firewallDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_firewallDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
}
},
{
"name": "get_app_firewall",
"description": "GET Application Firewall.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/app_firewalls/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"app-security-all-ns-events": {
"name": "app-security-all-ns-events",
"displayName": "App Security All Ns Events",
"operations": [
{
"name": "create_app_security_all_ns_event",
"description": "Security Events Query All Namespaces.",
"method": "POST",
"path": "/api/data/namespaces/system/app_security/all_ns_events",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to fetch security events.",
"title": "Security Events Request",
"x-displayname": "Security Events Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityEventsRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the security events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated...",
"x-f5xc-description-medium": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of security events returned in the response\nOptional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of security events returned in the response Optional: If not specified, first or last 500 security events that matches the query...",
"x-f5xc-description-medium": "Limits the number of security events returned in the response Optional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={app_type=\"blogging_app\"}",
"x-f5xc-example": "\"query={app_type=\"blogging_app\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the security event may be specified in the query. Vh_name - name of the virtual host src_site - source site city ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of security events (or all security events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of security events until there are no more security events left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of security events (or all security events) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of security events (or all security events) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of security events until there are no more security events left to return. The...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"title": "sort by",
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: default is sort by last_event_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/app_securitySearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityEventsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityEventsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"events": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityEventsRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of security events returned in the response\nOptional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of security events (or all security events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of security events until there are no more security events left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "events",
"type": "array",
"description": "List of security events that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security events using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityEventsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"app-security-all-ns-events-aggregation": {
"name": "app-security-all-ns-events-aggregation",
"displayName": "App Security All Ns Events Aggregation",
"operations": [
{
"name": "create_app_security_all_ns_events_aggregation",
"description": "Security Events Aggregation Query All Namespaces.",
"method": "POST",
"path": "/api/data/namespaces/system/app_security/all_ns_events/aggregation",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for security events.",
"title": "Security Events Aggregation Request",
"x-displayname": "Security Events Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityEventsAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the security events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated...",
"x-f5xc-description-medium": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={app_type=\"blogging_app\"}",
"x-f5xc-example": "\"query={app_type=\"blogging_app\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the security event may be specified in the query. Vh_name - name of the virtual host src_site - source site city ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for security events.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityEventsAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityEventsAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityEventsAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"app-security-all-ns-search-loadbalancers": {
"name": "app-security-all-ns-search-loadbalancers",
"displayName": "App Security All Ns Search Loadbalancers",
"operations": [
{
"name": "create_app_security_all_ns_search_loadbalancer",
"description": "Search load balancers All Namespaces.",
"method": "POST",
"path": "/api/data/namespaces/system/app_security/all_ns_search/loadbalancers",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "GET a list of virtual hosts in all the namespaces matching filter provided in the request.\nThe filter can be a) Request ID b) Source IP.",
"title": "SearchLoadBalancersRequest",
"x-displayname": "Search Load Balancers Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SearchLoadBalancersRequest",
"properties": {
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" `Op` \"value\".\nResponse will only contain data that matches all the conditions specified in the `label_filter`.\nOne or more of the following labels can be specified in the label_filter.\n`REQUEST_ID`, `SOURCE_IP``.",
"title": "Label Filter",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/app_securitySearchFilter"
},
"x-displayname": "Label Filter.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "5"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "5"
},
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" \"value\". Response will only contain data that matches all the conditions specified in the .",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" \"value\". Response will only contain data that matches all the conditions specified in the . One or more of the following labels can be specified in the label_filter. , `.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "GET a list of virtual hosts in all the namespaces matching filter provided in the request.",
"x-f5xc-description-medium": "GET a list of virtual hosts in all the namespaces matching filter provided in the request. The filter can be a) Request ID b) Source IP.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySearchLoadBalancersRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySearchLoadBalancersRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"loadbalancers": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySearchLoadBalancersRequest"
},
"fieldMetadata": {
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" `Op` \"value\".\nResponse will only contain data that matches all the conditions specified in the `label_filter`.\nOne or more of the following labels can be specified in the label_filter.\n`REQUEST_ID`, `SOURCE_IP``.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "loadbalancers",
"type": "array",
"description": "HTTP load balancer list for which the SearchFilter is applied."
}
]
}
]
},
	"app-settings": {
"name": "app-settings",
"displayName": "App Settings",
"operations": [
{
"name": "create_app_setting",
"description": "Create App Setting.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/app_settings",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of app_setting",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.app_setting.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/schemaapp_settingCreateSpecType"
}
],
"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 app_settingCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_settingCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_settingCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create App setting configuration in namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_type_settings": {
"type": "array",
"description": "List of settings to enable for each AppType, given instance of AppType Exist in this Namespace.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_app_setting",
"description": "Replace App Setting.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/app_settings/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a app_setting",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.app_setting.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/schemaapp_settingReplaceSpecType"
}
],
"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 app_settingReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_settingReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_settingReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an App setting will update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_type_settings": {
"type": "array",
"description": "List of settings to enable for each AppType, given instance of AppType Exist in this Namespace.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_app_settings",
"description": "List App Setting.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/app_settings",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_app_setting",
"description": "DELETE App Setting.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/app_settings/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a app_setting",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.app_setting.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_settingDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_settingDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
}
},
{
"name": "get_app_setting",
"description": "GET App Setting.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/app_settings/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"app-types": {
"name": "app-types",
"displayName": "App Types",
"operations": [
{
"name": "create_app_type",
"description": "Create App Type.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/app_types",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of app_type",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.app_type.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/app_typeCreateSpecType"
}
],
"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 app_typeCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create App type will create the configuration in namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting": {
"type": "object",
"description": "Settings specifying how API Discovery will be performed.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting.disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting.enable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.features": {
"type": "array",
"description": "List of various AI/ML features enabled.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.business_logic_markup_setting.learn_from_redirect_traffic": [
"disable",
"enable"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_app_type",
"description": "Replace App Type.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/app_types/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a app_type",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.app_type.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/app_typeReplaceSpecType"
}
],
"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 app_typeReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting": {
"type": "object",
"description": "Settings specifying how API Discovery will be performed.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting.disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.business_logic_markup_setting.enable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.features": {
"type": "array",
"description": "List of various AI/ML features enabled.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.business_logic_markup_setting.learn_from_redirect_traffic": [
"disable",
"enable"
]
}
},
{
"name": "list_app_types",
"description": "List App Type.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/app_types",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_app_type",
"description": "DELETE App Type.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/app_types/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a app_type",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.app_type.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_typeDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
}
},
{
"name": "get_app_type",
"description": "GET App Type.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/app_types/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"application-inventory": {
"name": "application-inventory",
"displayName": "Application Inventory",
"operations": [
{
"name": "create_application_inventory",
"description": "Application Objects Inventory.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/application_inventory",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for inventory of application related objects from all namespaces.",
"title": "ApplicationInventoryRequest",
"x-displayname": "Application related objects inventory request.",
"x-ves-proto-message": "ves.io.schema.namespace.ApplicationInventoryRequest",
"properties": {
"bigip_virtual_server_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceBIGIPVirtualServerInventoryFilterType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for cdn load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for http load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"nginx_one_server_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceNGINXOneServerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for nginx one server filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceTCPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for tcp load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"third_party_application_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceThirdPartyApplicationFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for third party application filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter": {
"allOf": [
{
"$ref": "#/components/schemas/namespaceUDPLoadbalancerInventoryFilterType"
}
],
"x-f5xc-description-short": "Configuration parameter for udp load balancer filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for inventory of application related objects from all namespaces.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceApplicationInventoryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceApplicationInventoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"loadbalancers": {
"type": "integer"
},
"origin_pools": {
"type": "integer"
},
"services_discovered": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceApplicationInventoryRequest"
},
"fieldMetadata": {
"bigip_virtual_server_filter": {
"type": "object",
"description": "BIG-IP Virtual Server Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_server_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with BIG-IP Virtual Server with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_server_filter.waf_configured": {
"type": "boolean",
"description": "Filter results with BIG-IP Virtual Server with WAF configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter": {
"type": "object",
"description": "HTTP Loadbalancer Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_definition": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Definition.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_protection": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Protection configured.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.api_schema_validation": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Schema Validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.bot_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Bot Protection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.client_blocking": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Blocking.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.client_side_defense": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Side Defense configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.cookie_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Cookie Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.cors_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CORS Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.csrf_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CSRF Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.data_guard": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Data Guard.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ddos_auto_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ddos_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS detection enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.default_loadbalancer": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Default Loadbalancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.graph_ql_inspection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with GraphQL Inspection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.http_only": {
"type": "boolean",
"description": "Filter results with HTTP only loadbalancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.ip_reputation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with IP Reputation configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.malicious_user_detection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Detection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.malicious_user_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.malware_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malware Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.mutual_tls": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with mTLS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.origin_server_subset": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Origin Server Subset.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"cdn_load_balancer_filter.routes": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.slow_ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Slow DDoS Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.trusted_client": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.trusted_client_ip_headers": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client IP Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.waf": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cdn_load_balancer_filter.waf_exclusion": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF Exclusion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter": {
"type": "object",
"description": "HTTP Loadbalancer Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_definition": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Definition.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_protection": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Protection configured.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.api_schema_validation": {
      "type": "boolean",
"description": "Filter results with HTTP loadbalancers with API Schema Validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.bot_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Bot Protection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.client_blocking": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Blocking.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.client_side_defense": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Client Side Defense configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.cookie_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Cookie Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.cors_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CORS Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.csrf_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with CSRF Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.data_guard": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Data Guard.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ddos_auto_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ddos_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with L7 DDoS detection enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.default_loadbalancer": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Default Loadbalancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.graph_ql_inspection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with GraphQL Inspection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.http_only": {
"type": "boolean",
"description": "Filter results with HTTP only loadbalancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.ip_reputation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with IP Reputation configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.malicious_user_detection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Detection configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.malicious_user_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malicious User Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.malware_protection": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Malware Protection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.mutual_tls": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with mTLS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.origin_server_subset": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Origin Server Subset.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"http_load_balancer_filter.routes": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.slow_ddos_mitigation": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Slow DDoS Mitigation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.trusted_client": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.trusted_client_ip_headers": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with Trusted Client IP Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.waf": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_load_balancer_filter.waf_exclusion": {
"type": "boolean",
"description": "Filter results with HTTP loadbalancers with WAF Exclusion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter": {
"type": "object",
"description": "NGINX One Server Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with NGINX One Server with specified API Discovery enablement state.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nginx_one_server_filter.waf_configured": {
"type": "boolean",
"description": "Filter results with NGINX One Server with specified WAF enablement state.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter": {
"type": "object",
"description": "TCP Loadbalancer inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"tcp_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_load_balancer_filter.tls_encryption": {
"type": "boolean",
"description": "Filter results with TCP loadbalancers with TLS Encryption configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"third_party_application_filter": {
"type": "object",
"description": "Third Party Application Inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"third_party_application_filter.api_discovery": {
      "type": "boolean",
"description": "Filter results with Third Party Application with API Discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter": {
"type": "object",
"description": "UDP Loadbalancer inventory Filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter.namespace_service_policy": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers with Namespace Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter.private_advertisement": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers advertised privately.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"udp_load_balancer_filter.public_advertisement": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers advertised publicly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "public_advertisment"
},
"udp_load_balancer_filter.service_policy": {
"type": "boolean",
"description": "Filter results with UDP loadbalancers with Service Policy configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bigip_virtual_servers",
"type": "object",
"description": ""
},
{
"field": "cdn_loadbalancers",
"type": "object",
"description": ""
},
{
"field": "http_loadbalancers",
"type": "object",
"description": ""
},
{
"field": "loadbalancers",
"type": "integer",
"description": "Number of HTTP and TCP Load Balancers configured."
},
{
"field": "nginx_one_servers",
"type": "object",
"description": ""
},
{
"field": "origin_pools",
"type": "integer",
"description": "Number of origin pools configured."
},
{
"field": "services_discovered",
"type": "integer",
"description": "Number of services discovered."
},
{
"field": "tcp_loadbalancers",
"type": "object",
"description": ""
},
{
"field": "third_party_applications",
"type": "object",
"description": ""
},
{
"field": "udp_loadbalancers",
"type": "object",
"description": ""
}
]
}
]
},
	"application-profiless": {
"name": "application-profiless",
"displayName": "Application Profiless",
"operations": [
{
"name": "create_application_profile",
"description": "Create Application Profiles.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/application_profiless",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of application_profiles",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.application_profiles.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/application_profilesCreateSpecType"
}
],
"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 application_profilesCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for application_profilesCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for application_profilesCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Application Profiles in a given namespace. If one already exists it will give an error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_tcp_profile": {
"type": "object",
"description": "BIG-IP Advanced TCP Profile.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_tcp_profile.disable_tcp_advanced_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_tcp_profile.enable_tcp_advanced_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile": {
"type": "object",
"description": "BIG-IP DDoS Protection Rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.disable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.enable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules": {
"type": "array",
"description": "OPTIONS for attaching iRules to BIG-IP Proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server": {
"type": "object",
"description": "Specifies configuration related to virtual server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.address_translation": {
"type": "object",
"description": "Specifies, when checked (enabled), that the system translates the address of the virtual server. When cleared (disabled), specifies that the system uses the address without translation. This option is useful when the system is load balancing devices that have the same IP address. The default is enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.auto_last_hop": {
"type": "object",
"description": "When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. For example, if the system does not have a default route configured and the client is located on a remote network. This setting is also useful when the system is load balancing transparent devices that do not modify the source IP address of the packet. Without the last hop option enabled, the system could return connections to a different transparent node, resulting in asymmetric routing. You can configure this setting globally and on an object level. You set the global Auto Last Hop value on the System :: Configuration :: Local Traffic :: General screen. To configure this setting globally, retain the Default setting. When you configure Auto Last Hop with a value other than Default at the object level, its setting takes precedence over the global setting. This enables you to configure auto last hop on a per-virtual server basis. The default is Default, meaning that the system uses the global auto-lasthop setting to send back the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.clone_pool_client": {
"type": "array",
"description": "Replicates client-side traffic (that is, prior to address translation) to a member of the specified pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.clone_pool_server": {
"type": "array",
"description": "Replicates server-side traffic (that is, prior to address translation) to a member of the specified pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.connection_limit": {
"type": "integer",
"description": "Specifies the maximum number of concurrent connections allowed for the virtual server. Setting this to 0 turns off connection limits. The default is 0.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.connection_rate_limit": {
"type": "integer",
"description": "Specifies the maximum number of connections-per-second allowed for a virtual server. When the number of connections-per-second reaches the limit for a given virtual server, the system drops (UDP) or resets (TCP) additional connection requests. This helps detect Denial of Service attacks, where connection requests flood a virtual server. Setting this to 0 turns off connection limits. The default is 0.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.connection_rate_limit_mode": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.default_persistence_profile": {
"type": "array",
"description": "Configuration parameter for default persistence profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.default_pool": {
"type": "array",
"description": "Specifies the pool name that you want the virtual server to use as the default pool. A load balancing virtual server sends traffic to this pool automatically, unless an iRule directs the server to send the traffic to another pool instead.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.fallback_persistence_profile": {
"type": "array",
"description": "Configuration parameter for fallback persistence profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.fix_profile": {
"type": "array",
"description": "Configuration parameter for fix profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.http": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.http3": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.https": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.immediate_action_on_service_down": {
"type": "object",
"description": "Specifies the immediate action the BIG-IP system should respond with upon the receipt of the initial client's SYN packet, if the availability status of the virtual server is Offline or Unavailable. This is supported for the virtual server of Standard type and TCP protocol. The default is None.\nNone: Specifies that the system takes no immediate action if the virtual server is reported Offline or Unavailable.\nReset: Specifies that the system resets the connections when the virtual server is reported Offline or Unavailable.\nDrop: Specifies that the system drops the connections when the virtual server is reported Offline or Unavailable.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.last_hop_pool": {
"type": "array",
"description": "Directs reply traffic to the last hop router using the specified pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.nat64": {
"type": "object",
"description": "When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. For example, if the system does not have a default route configured and the client is located on a remote network. This setting is also useful when the system is load balancing transparent devices that do not modify the source IP address of the packet. Without the last hop option enabled, the system could return connections to a different transparent node, resulting in asymmetric routing. You can configure this setting globally and on an object level. You set the global Auto Last Hop value on the System :: Configuration :: Local Traffic :: General screen. To configure this setting globally, retain the Default setting. When you configure Auto Last Hop with a value other than Default at the object level, its setting takes precedence over the global setting. This enables you to configure auto last hop on a per-virtual server basis. The default is Default, meaning that the system uses the global auto-lasthop setting to send back the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.port_translation": {
"type": "object",
"description": "Specifies, when checked (enabled), that the system translates the port of the virtual server. When cleared (disabled), specifies that the system uses the port without translation. Turning off port translation for a virtual server is useful if you want to use the virtual server to load balance connections to any service. The default is enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.request_logging_profile": {
"type": "array",
"description": "Configuration parameter for request logging profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.source_port": {
"type": "object",
"description": "Specifies whether the system preserves the source port of the connection. The default is Preserve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.statistics_profile": {
"type": "array",
"description": "Configuration parameter for statistics profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.tcp": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.udp": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.virtual_server_state": {
"type": "object",
"description": "Displays the current state on the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.vs_score": {
"type": "integer",
"description": "Specifies the virtual server score in percent. Global Traffic Manager (GTM) can rely on this value to load balance traffic in a proportional manner. The default is 0, meaning that no additional metric is applied for the virtual server.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advanced_tcp_profile.tcp_advanced_profile_choice": [
"disable_tcp_advanced_profile",
"enable_tcp_advanced_profile"
],
"spec.ddos_profile.ddos_mitigation_choice": [
"disable_ddos_mitigation",
"enable_ddos_mitigation"
],
"spec.virtual_server.virtual_server_type": [
"http",
"http3",
"https",
"tcp",
"udp"
],
"spec.virtual_server.address_translation.address_translation_choice": [
"address_translation_disable",
"address_translation_enable"
],
"spec.virtual_server.auto_last_hop.auto_last_hop_choice": [
"auto_last_hop_default",
"auto_last_hop_disable",
"auto_last_hop_enable"
],
"spec.virtual_server.connection_rate_limit_mode.connection_rate_limit_mode_choice": [
"per_destination_address",
"per_source_address",
"per_source_destination_address",
"per_virtual_server",
"per_virtual_server_destination_address",
"per_virtual_server_source_address",
"per_virtual_server_source_destination_address"
],
"spec.virtual_server.immediate_action_on_service_down.immediate_action_on_service_down_choice": [
"immediate_action_on_service_down_drop",
"immediate_action_on_service_down_none",
"immediate_action_on_service_down_reset"
],
"spec.virtual_server.nat64.nat64_choice": [
"nat64_disable",
"nat64_enable"
],
"spec.virtual_server.port_translation.port_translation_choice": [
"port_translation_disable",
"port_translation_enable"
],
"spec.virtual_server.source_port.source_port_choice": [
"source_port_change",
"source_port_preserve",
"source_port_preserve_strict"
],
"spec.virtual_server.virtual_server_state.state_choice": [
"state_disabled",
"state_enabled"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_application_profile",
"description": "Replace Application Profiles.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/application_profiless/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a application_profiles",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.application_profiles.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/application_profilesReplaceSpecType"
}
],
"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 application_profilesReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for application_profilesReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for application_profilesReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Application Profiles in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_tcp_profile": {
"type": "object",
"description": "BIG-IP Advanced TCP Profile.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_tcp_profile.disable_tcp_advanced_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_tcp_profile.enable_tcp_advanced_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile": {
"type": "object",
"description": "BIG-IP DDoS Protection Rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.disable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.enable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules": {
"type": "array",
"description": "OPTIONS for attaching iRules to BIG-IP Proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server": {
"type": "object",
"description": "Specifies configuration related to virtual server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.address_translation": {
"type": "object",
"description": "Specifies, when checked (enabled), that the system translates the address of the virtual server. When cleared (disabled), specifies that the system uses the address without translation. This option is useful when the system is load balancing devices that have the same IP address. The default is enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.auto_last_hop": {
"type": "object",
"description": "When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. For example, if the system does not have a default route configured and the client is located on a remote network. This setting is also useful when the system is load balancing transparent devices that do not modify the source IP address of the packet. Without the last hop option enabled, the system could return connections to a different transparent node, resulting in asymmetric routing. You can configure this setting globally and on an object level. You set the global Auto Last Hop value on the System :: Configuration :: Local Traffic :: General screen. To configure this setting globally, retain the Default setting. When you configure Auto Last Hop with a value other than Default at the object level, its setting takes precedence over the global setting. This enables you to configure auto last hop on a per-virtual server basis. The default is Default, meaning that the system uses the global auto-lasthop setting to send back the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.clone_pool_client": {
"type": "array",
"description": "Replicates client-side traffic (that is, prior to address translation) to a member of the specified pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.clone_pool_server": {
"type": "array",
"description": "Replicates server-side traffic (that is, prior to address translation) to a member of the specified pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.connection_limit": {
"type": "integer",
"description": "Specifies the maximum number of concurrent connections allowed for the virtual server. Setting this to 0 turns off connection limits. The default is 0.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.connection_rate_limit": {
"type": "integer",
"description": "Specifies the maximum number of connections-per-second allowed for a virtual server. When the number of connections-per-second reaches the limit for a given virtual server, the system drops (UDP) or resets (TCP) additional connection requests. This helps detect Denial of Service attacks, where connection requests flood a virtual server. Setting this to 0 turns off connection limits. The default is 0.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.connection_rate_limit_mode": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.default_persistence_profile": {
"type": "array",
"description": "Configuration parameter for default persistence profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.default_pool": {
"type": "array",
"description": "Specifies the pool name that you want the virtual server to use as the default pool. A load balancing virtual server sends traffic to this pool automatically, unless an iRule directs the server to send the traffic to another pool instead.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.fallback_persistence_profile": {
"type": "array",
"description": "Configuration parameter for fallback persistence profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.fix_profile": {
"type": "array",
"description": "Configuration parameter for fix profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.http": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.http3": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.https": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.immediate_action_on_service_down": {
"type": "object",
"description": "Specifies the immediate action the BIG-IP system should respond with upon the receipt of the initial client's SYN packet, if the availability status of the virtual server is Offline or Unavailable. This is supported for the virtual server of Standard type and TCP protocol. The default is None.\nNone: Specifies that the system takes no immediate action if the virtual server is reported Offline or Unavailable.\nReset: Specifies that the system resets the connections when the virtual server is reported Offline or Unavailable.\nDrop: Specifies that the system drops the connections when the virtual server is reported Offline or Unavailable.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.last_hop_pool": {
"type": "array",
"description": "Directs reply traffic to the last hop router using the specified pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.nat64": {
"type": "object",
"description": "When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. For example, if the system does not have a default route configured and the client is located on a remote network. This setting is also useful when the system is load balancing transparent devices that do not modify the source IP address of the packet. Without the last hop option enabled, the system could return connections to a different transparent node, resulting in asymmetric routing. You can configure this setting globally and on an object level. You set the global Auto Last Hop value on the System :: Configuration :: Local Traffic :: General screen. To configure this setting globally, retain the Default setting. When you configure Auto Last Hop with a value other than Default at the object level, its setting takes precedence over the global setting. This enables you to configure auto last hop on a per-virtual server basis. The default is Default, meaning that the system uses the global auto-lasthop setting to send back the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.port_translation": {
"type": "object",
"description": "Specifies, when checked (enabled), that the system translates the port of the virtual server. When cleared (disabled), specifies that the system uses the port without translation. Turning off port translation for a virtual server is useful if you want to use the virtual server to load balance connections to any service. The default is enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.request_logging_profile": {
"type": "array",
"description": "Configuration parameter for request logging profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.source_port": {
"type": "object",
"description": "Specifies whether the system preserves the source port of the connection. The default is Preserve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.statistics_profile": {
"type": "array",
"description": "Configuration parameter for statistics profile",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.tcp": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.udp": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.virtual_server_state": {
"type": "object",
"description": "Displays the current state on the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_server.vs_score": {
"type": "integer",
"description": "Specifies the virtual server score in percent. Global Traffic Manager (GTM) can rely on this value to load balance traffic in a proportional manner. The default is 0, meaning that no additional metric is applied for the virtual server.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advanced_tcp_profile.tcp_advanced_profile_choice": [
"disable_tcp_advanced_profile",
"enable_tcp_advanced_profile"
],
"spec.ddos_profile.ddos_mitigation_choice": [
"disable_ddos_mitigation",
"enable_ddos_mitigation"
],
"spec.virtual_server.virtual_server_type": [
"http",
"http3",
"https",
"tcp",
"udp"
],
"spec.virtual_server.address_translation.address_translation_choice": [
"address_translation_disable",
"address_translation_enable"
],
"spec.virtual_server.auto_last_hop.auto_last_hop_choice": [
"auto_last_hop_default",
"auto_last_hop_disable",
"auto_last_hop_enable"
],
"spec.virtual_server.connection_rate_limit_mode.connection_rate_limit_mode_choice": [
"per_destination_address",
"per_source_address",
"per_source_destination_address",
"per_virtual_server",
"per_virtual_server_destination_address",
"per_virtual_server_source_address",
"per_virtual_server_source_destination_address"
],
"spec.virtual_server.immediate_action_on_service_down.immediate_action_on_service_down_choice": [
"immediate_action_on_service_down_drop",
"immediate_action_on_service_down_none",
"immediate_action_on_service_down_reset"
],
"spec.virtual_server.nat64.nat64_choice": [
"nat64_disable",
"nat64_enable"
],
"spec.virtual_server.port_translation.port_translation_choice": [
"port_translation_disable",
"port_translation_enable"
],
"spec.virtual_server.source_port.source_port_choice": [
"source_port_change",
"source_port_preserve",
"source_port_preserve_strict"
],
"spec.virtual_server.virtual_server_state.state_choice": [
"state_disabled",
"state_enabled"
]
}
},
{
"name": "list_application_profiless",
"description": "List Configure Application Profiles.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/application_profiless",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_application_profile",
"description": "DELETE Configure Application Profiles.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/application_profiless/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a application_profiles",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.application_profiles.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for application_profilesDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for application_profilesDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_application_profile",
"description": "GET Application Profiles.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/application_profiless/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"associated-objects": {
"name": "associated-objects",
"displayName": "Associated Objects",
"operations": [
{
"name": "list_associated_objects",
"description": "GET Associated Objects.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_servers/{name}/associated-objects",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"irules": {
"type": "array"
},
"virtual_addresses": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "irules",
"type": "array",
"description": "IRules for this virtual server."
},
{
"field": "virtual_addresses",
"type": "array",
"description": "Virtual address objects for this virtual server."
}
]
}
]
},
	"audit-logs": {
"name": "audit-logs",
"displayName": "Audit Logs",
"operations": [
{
"name": "create_audit_log",
"description": "Audit Log Query V2.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/audit_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch audit logs.",
"title": "AuditLogRequestV2",
"x-displayname": "Audit Log Request V2.",
"x-ves-proto-message": "ves.io.schema.log.AuditLogRequestV2",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch audit logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request URL\nrsp_code - response code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={req_path=\"/public/namespaces/system/registrations\"} will return all audit logs with req_path equals /public/namespaces/system/registrations\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "{user=\\\"abc\\\", rsp_code=\\\"404\\\"}",
"x-f5xc-example": "\"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_site - source site src - source service...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logAuditLogRequestV2",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logAuditLogRequestV2\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logAuditLogRequestV2"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch audit logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request URL\nrsp_code - response code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={req_path=\"/public/namespaces/system/registrations\"} will return all audit logs with req_path equals /public/namespaces/system/registrations\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"authentications": {
"name": "authentications",
      "displayName": "Authentications",
      "operations": [
{
"name": "create_authentication",
      "description": "Create Authentication.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/authentications",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of authentication",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.authentication.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/authenticationCreateSpecType"
      }
],
"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 authenticationCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authenticationCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for authenticationCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params": {
"type": "object",
"description": "Specifies different cookie related config parameters for authentication.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.auth_hmac": {
      "type": "object",
"description": "HMAC primary and secondary keys to be used for hashing the Cookie.\nEach key also have an associated expiry timestamp, beyond which key is invalid.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.cookie_expiry": {
"type": "integer",
"description": "Specifies in seconds max duration of the allocated cookie. This maps to “Max-Age” attribute in the session cookie.\nThis will act as an expiry duration on the client side after which client will not be setting the\ncookie as part of the request.\nDefault cookie expiry is 3600 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.cookie_refresh_interval": {
"type": "integer",
"description": "Specifies in seconds refresh interval for session cookie.\nThis is used to keep the active user active and reduce RE-login.\nWhen an incoming cookie's session expiry is still valid, and time to expire falls behind this interval,\nRE-issue a cookie with new expiry and with the same original session expiry.\nDefault refresh interval is 3000 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.kms_key_hmac": {
      "type": "object",
"description": "Reference to KMS Key Object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.session_expiry": {
"type": "integer",
"description": "Specifies in seconds max lifetime of an authenticated session after which the user will be forced to login again.\nDefault session expiry is 86400 seconds(24 hours).",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1296000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth.client_secret": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth.oidc_auth_params": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth.oidc_client_id": {
      "type": "string",
"description": "Client ID used while sending the Authorization Request to OIDC server.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.oidc_auth.oidc_well_known_config_url": {
      "type": "string",
"description": "Exclusive with [oidc_auth_params]\nAn OIDC well-known configuration URL that will be used to fetch authentication related endpoints.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.auth_type_choice": [
      "oidc_auth"
      ],
"spec.cookie_params.secret_choice": [
      "auth_hmac",
      "kms_key_hmac"
      ],
"spec.oidc_auth.auth_params_choice": [
      "oidc_auth_params",
      "oidc_well_known_config_url"
],
"spec.oidc_auth.client_secret.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_authentication",
      "description": "Replace Authentication.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/authentications/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a authentication",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.authentication.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/authenticationReplaceSpecType"
      }
],
"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 authenticationReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authenticationReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for authenticationReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params": {
"type": "object",
"description": "Specifies different cookie related config parameters for authentication.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.auth_hmac": {
      "type": "object",
"description": "HMAC primary and secondary keys to be used for hashing the Cookie.\nEach key also have an associated expiry timestamp, beyond which key is invalid.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.cookie_expiry": {
"type": "integer",
"description": "Specifies in seconds max duration of the allocated cookie. This maps to “Max-Age” attribute in the session cookie.\nThis will act as an expiry duration on the client side after which client will not be setting the\ncookie as part of the request.\nDefault cookie expiry is 3600 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.cookie_refresh_interval": {
"type": "integer",
"description": "Specifies in seconds refresh interval for session cookie.\nThis is used to keep the active user active and reduce RE-login.\nWhen an incoming cookie's session expiry is still valid, and time to expire falls behind this interval,\nRE-issue a cookie with new expiry and with the same original session expiry.\nDefault refresh interval is 3000 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.kms_key_hmac": {
      "type": "object",
"description": "Reference to KMS Key Object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_params.session_expiry": {
"type": "integer",
"description": "Specifies in seconds max lifetime of an authenticated session after which the user will be forced to login again.\nDefault session expiry is 86400 seconds(24 hours).",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1296000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth.client_secret": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth.oidc_auth_params": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_auth.oidc_client_id": {
      "type": "string",
"description": "Client ID used while sending the Authorization Request to OIDC server.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.oidc_auth.oidc_well_known_config_url": {
      "type": "string",
"description": "Exclusive with [oidc_auth_params]\nAn OIDC well-known configuration URL that will be used to fetch authentication related endpoints.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.auth_type_choice": [
      "oidc_auth"
      ],
"spec.cookie_params.secret_choice": [
      "auth_hmac",
      "kms_key_hmac"
      ],
"spec.oidc_auth.auth_params_choice": [
      "oidc_auth_params",
      "oidc_well_known_config_url"
],
"spec.oidc_auth.client_secret.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_authentications",
      "description": "List Authentication.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/authentications",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_authentication",
      "description": "DELETE Authentication.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/authentications/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a authentication",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.authentication.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for authenticationDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authenticationDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_authentication",
      "description": "GET Authentication.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/authentications/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"authorization-servers": {
"name": "authorization-servers",
      "displayName": "Authorization Servers",
      "operations": [
{
"name": "create_authorization_server",
      "description": "Create Authorization Server.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/authorization_servers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of authorization_server",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.authorization_server.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/authorization_serverCreateSpecType"
      }
],
"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 authorization_serverCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authorization_serverCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for authorization_serverCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create authorization_server creates a new object in the storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwks_uri": {
"type": "string",
"description": "X-textBlockContent:\nAutomatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_authorization_server",
      "description": "Replace Authorization Server.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/authorization_servers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a authorization_server",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.authorization_server.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/authorization_serverReplaceSpecType"
      }
],
"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 authorization_serverReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authorization_serverReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for authorization_serverReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace authorization_server replaces an existing object in the storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwks_uri": {
"type": "string",
"description": "X-textBlockContent:\nAutomatic fetching of JWKS will happen once daily. You can also do it manually from the list of Authorization Servers at any time.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_authorization_servers",
      "description": "List Authorization Server.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/authorization_servers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_authorization_server",
      "description": "DELETE Authorization Server.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/authorization_servers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a authorization_server",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.authorization_server.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for authorization_serverDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authorization_serverDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_authorization_server",
      "description": "GET Authorization Server.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/authorization_servers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"aws-tgw-sites": {
"name": "aws-tgw-sites",
"displayName": "Aws Tgw Sites",
"operations": [
{
"name": "create_aws_tgw_site",
"description": "Create AWS TGW site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_tgw_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of aws_tgw_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.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/viewsaws_tgw_siteCreateSpecType"
}
],
"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 aws_tgw_siteCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_tgw_siteCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the AWS TGW site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters": {
"type": "object",
"description": "Setup AWS services VPC, transit gateway and site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.aws_region": {
"type": "string",
"description": "AWS Region of your services VPC, where F5XC site will be deployed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.custom_security_group": {
"type": "object",
"description": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.disable_encryption": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.disable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.disk_size": {
"type": "integer",
"description": "Node disk size for all node in the F5XC site. Unit is GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 64000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.enable_encryption": {
"type": "object",
"description": "Information related to disk encryption.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.enable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.existing_tgw": {
"type": "object",
"description": "Information needed for existing TGW.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.f5xc_security_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.instance_type": {
"type": "string",
"description": "Instance size based on the performance.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.new_tgw": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.new_vpc": {
"type": "object",
"description": "Parameters to create new AWS VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.no_worker_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.nodes_per_az": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 21,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.reserved_tgw_cidr": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing nodes of the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.tgw_cidr": {
"type": "object",
"description": "Parameters for creating a new cloud subnet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.total_nodes": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 61,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.vpc_id": {
"type": "string",
"description": "Exclusive with [new_vpc]\nExisting VPC ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled": {
"type": "object",
"description": "Direct Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.auto_asn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.custom_asn": {
"type": "integer",
"description": "Exclusive with [auto_asn]\nCustom Autonomous System Number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.hosted_vifs": {
"type": "object",
"description": "AWS Direct Connect Hosted VIF Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.standard_vifs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity": {
"type": "object",
"description": "Private Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.cloud_link": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tags": {
"type": "object",
"description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security": {
"type": "object",
"description": "Security Configuration for transit gateway.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_east_west_service_policies": {
"type": "object",
"description": "Active service policies for the east-west proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.east_west_service_policy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.no_east_west_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config": {
"type": "object",
"description": "Virtual Network Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.allowed_vip_port_sli": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc_attachments": {
"type": "object",
"description": "Spoke VPCs to be attached to the AWS TGW Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc_attachments.vpc_list": {
"type": "array",
"description": "List of VPC attachments to transit gateway.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.direct_connect_choice": [
"direct_connect_disabled",
"direct_connect_enabled",
"private_connectivity"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.aws_parameters.deployment": [
"aws_cred"
],
"spec.aws_parameters.encryption_choice": [
"disable_encryption",
"enable_encryption"
],
"spec.aws_parameters.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.aws_parameters.security_group_choice": [
"custom_security_group",
"f5xc_security_group"
],
"spec.aws_parameters.service_vpc_choice": [
"new_vpc",
"vpc_id"
],
"spec.aws_parameters.tgw_choice": [
"existing_tgw",
"new_tgw"
],
"spec.aws_parameters.tgw_cidr_choice": [
"reserved_tgw_cidr",
"tgw_cidr"
],
"spec.aws_parameters.worker_nodes": [
"no_worker_nodes",
"nodes_per_az",
"total_nodes"
],
"spec.aws_parameters.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.aws_parameters.new_tgw.asn_choice": [
"system_generated",
"user_assigned"
],
"spec.aws_parameters.new_vpc.name_choice": [
"autogenerate",
"name_tag"
],
"spec.direct_connect_enabled.asn_choice": [
"auto_asn",
"custom_asn"
],
"spec.direct_connect_enabled.vif_choice": [
"hosted_vifs",
"standard_vifs"
],
"spec.direct_connect_enabled.hosted_vifs.connectivity_options": [
"site_registration_over_direct_connect",
"site_registration_over_internet"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
],
"spec.private_connectivity.network_options": [
"inside",
"outside"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
],
"spec.tgw_security.east_west_service_policy_choice": [
"active_east_west_service_policies",
"east_west_service_policy_allow_all",
"no_east_west_policy"
],
"spec.tgw_security.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.tgw_security.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.vn_config.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.vn_config.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.vn_config.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.vn_config.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.vn_config.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.vn_config.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.vn_config.allowed_vip_port_sli.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_aws_tgw_site",
"description": "Replace AWS TGW site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/aws_tgw_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a aws_tgw_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.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/viewsaws_tgw_siteReplaceSpecType"
}
],
"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 aws_tgw_siteReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_tgw_siteReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the AWS TGW site replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters": {
"type": "object",
"description": "AWS Services VPC Replace config.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.aws_region": {
"type": "string",
"description": "AWS Region of your services VPC, where F5XC site will be deployed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.custom_security_group": {
"type": "object",
"description": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.disable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.disk_size": {
"type": "integer",
"description": "Node disk size for all node in the F5XC site. Unit is GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 64000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.enable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.existing_tgw": {
"type": "object",
"description": "Information needed for existing TGW.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.f5xc_security_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.instance_type": {
"type": "string",
"description": "Instance size based on the performance.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.new_tgw": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.new_vpc": {
"type": "object",
"description": "Parameters to create new AWS VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.no_worker_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.nodes_per_az": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 21,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing nodes of the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_parameters.total_nodes": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 61,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_parameters.vpc_id": {
"type": "string",
"description": "Exclusive with [new_vpc]\nExisting VPC ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled": {
"type": "object",
"description": "Direct Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.auto_asn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.custom_asn": {
"type": "integer",
"description": "Exclusive with [auto_asn]\nCustom Autonomous System Number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.hosted_vifs": {
"type": "object",
"description": "AWS Direct Connect Hosted VIF Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.standard_vifs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity": {
"type": "object",
"description": "Private Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.cloud_link": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security": {
"type": "object",
"description": "Security Configuration for transit gateway.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_east_west_service_policies": {
"type": "object",
"description": "Active service policies for the east-west proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.east_west_service_policy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.no_east_west_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tgw_security.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config": {
"type": "object",
"description": "Virtual Network Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.allowed_vip_port_sli": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vn_config.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc_attachments": {
"type": "object",
"description": "Spoke VPCs to be attached to the AWS TGW Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc_attachments.vpc_list": {
"type": "array",
"description": "List of VPC attachments to transit gateway.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.direct_connect_choice": [
"direct_connect_disabled",
"direct_connect_enabled",
"private_connectivity"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.aws_parameters.deployment": [
"aws_cred"
],
"spec.aws_parameters.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.aws_parameters.security_group_choice": [
"custom_security_group",
"f5xc_security_group"
],
"spec.aws_parameters.service_vpc_choice": [
"new_vpc",
"vpc_id"
],
"spec.aws_parameters.tgw_choice": [
"existing_tgw",
"new_tgw"
],
"spec.aws_parameters.worker_nodes": [
"no_worker_nodes",
"nodes_per_az",
"total_nodes"
],
"spec.aws_parameters.new_tgw.asn_choice": [
"system_generated",
"user_assigned"
],
"spec.aws_parameters.new_vpc.name_choice": [
"autogenerate",
"name_tag"
],
"spec.direct_connect_enabled.asn_choice": [
"auto_asn",
"custom_asn"
],
"spec.direct_connect_enabled.vif_choice": [
"hosted_vifs",
"standard_vifs"
],
"spec.direct_connect_enabled.hosted_vifs.connectivity_options": [
"site_registration_over_direct_connect",
"site_registration_over_internet"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
],
"spec.private_connectivity.network_options": [
"inside",
"outside"
],
"spec.tgw_security.east_west_service_policy_choice": [
"active_east_west_service_policies",
"east_west_service_policy_allow_all",
"no_east_west_policy"
],
"spec.tgw_security.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.tgw_security.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.vn_config.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.vn_config.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.vn_config.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.vn_config.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.vn_config.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.vn_config.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.vn_config.allowed_vip_port_sli.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
]
}
},
{
"name": "list_aws_tgw_sites",
"description": "List Configure AWS TGW Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/aws_tgw_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_aws_tgw_site",
"description": "DELETE Configure AWS TGW Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/aws_tgw_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a aws_tgw_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_tgw_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
}
},
{
"name": "get_aws_tgw_site",
"description": "GET AWS TGW site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/aws_tgw_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"aws-vpc-sites": {
"name": "aws-vpc-sites",
"displayName": "Aws Vpc Sites",
"operations": [
{
"name": "create_aws_vpc_site",
"description": "Create AWS VPC site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_vpc_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of aws_vpc_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.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/viewsaws_vpc_siteCreateSpecType"
}
],
"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 aws_vpc_siteCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_vpc_siteCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_vpc_siteCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the AWS VPC site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_cred.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_region": {
"type": "string",
"description": "Name for AWS Region.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_security_group": {
"type": "object",
"description": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_security_group.inside_security_group_id": {
"type": "string",
"description": "Security Group ID to be attached to SLI(Site Local Inside) Interface.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_security_group.outside_security_group_id": {
"type": "string",
"description": "Security Group ID to be attached to SLO(Site Local Outside) Interface.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled": {
"type": "object",
"description": "Direct Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.auto_asn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.custom_asn": {
"type": "integer",
"description": "Exclusive with [auto_asn]\nCustom Autonomous System Number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.hosted_vifs": {
"type": "object",
"description": "AWS Direct Connect Hosted VIF Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.standard_vifs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_encryption": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disk_size": {
"type": "integer",
"description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 2048,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_gateway_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_nat_gw": {
"type": "object",
"description": "With this option, egress site traffic will be routed through an Network Address Translation(NAT) Gateway.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_nat_gw.nat_gw_id": {
"type": "string",
"description": "Exclusive with []",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 21,
"pattern": "^(nat-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_virtual_private_gateway": {
"type": "object",
"description": "With this option, egress site traffic will be routed through an Virtual Private Gateway.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_virtual_private_gateway.vgw_id": {
"type": "string",
"description": "Exclusive with []",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 21,
"pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_encryption": {
"type": "object",
"description": "Information related to disk encryption.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_encryption.kms_key_id": {
      "type": "string",
"description": "AWS KMS Key to be used to encrypt the disk attached to the VM.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_orchestrated_routing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5xc_security_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw": {
"type": "object",
"description": "Two interface AWS ingress/egress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.allowed_vip_port_sli": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.aws_certified_hw": {
"type": "string",
"description": "Name for AWS certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw": {
"type": "object",
"description": "Single interface AWS ingress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.aws_certified_hw": {
"type": "string",
"description": "Name for AWS certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.instance_type": {
"type": "string",
"description": "Select Instance size based on performance needed.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.manual_routing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_worker_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nodes_per_az": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 21,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity": {
"type": "object",
"description": "Private Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.cloud_link": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tags": {
"type": "object",
"description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.total_nodes": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 61,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster": {
"type": "object",
"description": "App Stack cluster of single interface AWS nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.aws_certified_hw": {
"type": "string",
"description": "Name for AWS certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.default_storage": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc": {
"type": "object",
"description": "This defines choice about AWS VPC for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc.new_vpc": {
"type": "object",
"description": "Parameters to create new AWS VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc.vpc_id": {
"type": "string",
"description": "Exclusive with [new_vpc]\nInformation about existing VPC ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.deployment": [
"aws_cred"
],
"spec.direct_connect_choice": [
"direct_connect_disabled",
"direct_connect_enabled",
"private_connectivity"
],
"spec.egress_gateway_choice": [
"egress_gateway_default",
"egress_nat_gw",
"egress_virtual_private_gateway"
],
"spec.encryption_choice": [
"disable_encryption",
"enable_encryption"
],
"spec.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.routing_type": [
"f5_orchestrated_routing",
"manual_routing"
],
"spec.security_group_choice": [
"custom_security_group",
"f5xc_security_group"
],
"spec.site_type": [
"ingress_egress_gw",
"ingress_gw",
"voltstack_cluster"
],
"spec.worker_nodes": [
"no_worker_nodes",
"nodes_per_az",
"total_nodes"
],
"spec.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.direct_connect_enabled.asn_choice": [
"auto_asn",
"custom_asn"
],
"spec.direct_connect_enabled.vif_choice": [
"hosted_vifs",
"standard_vifs"
],
"spec.direct_connect_enabled.hosted_vifs.connectivity_options": [
"site_registration_over_direct_connect",
"site_registration_over_internet"
],
"spec.egress_nat_gw.choice": [
"nat_gw_id"
],
"spec.egress_virtual_private_gateway.choice": [
"vgw_id"
],
"spec.ingress_egress_gw.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.ingress_egress_gw.allowed_vip_port_sli.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.ingress_egress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_gw.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.ingress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.private_connectivity.network_options": [
"inside",
"outside"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
],
"spec.voltstack_cluster.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster.storage_class_choice": [
"default_storage",
"storage_class_list"
],
"spec.voltstack_cluster.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.vpc.choice": [
"new_vpc",
"vpc_id"
],
"spec.vpc.new_vpc.name_choice": [
"autogenerate",
"name_tag"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_aws_vpc_site",
"description": "Replace AWS VPC site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/aws_vpc_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a aws_vpc_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.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/viewsaws_vpc_siteReplaceSpecType"
}
],
"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 aws_vpc_siteReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_vpc_siteReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_vpc_siteReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the AWS VPC site replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_cred.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_region": {
"type": "string",
"description": "Name for AWS Region.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_security_group": {
"type": "object",
"description": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_security_group.inside_security_group_id": {
"type": "string",
"description": "Security Group ID to be attached to SLI(Site Local Inside) Interface.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_security_group.outside_security_group_id": {
"type": "string",
"description": "Security Group ID to be attached to SLO(Site Local Outside) Interface.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled": {
"type": "object",
"description": "Direct Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.auto_asn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.custom_asn": {
"type": "integer",
"description": "Exclusive with [auto_asn]\nCustom Autonomous System Number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.hosted_vifs": {
"type": "object",
"description": "AWS Direct Connect Hosted VIF Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.direct_connect_enabled.standard_vifs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disk_size": {
"type": "integer",
"description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 2048,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_gateway_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_nat_gw": {
"type": "object",
"description": "With this option, egress site traffic will be routed through an Network Address Translation(NAT) Gateway.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_nat_gw.nat_gw_id": {
"type": "string",
"description": "Exclusive with []",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 21,
"pattern": "^(nat-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_virtual_private_gateway": {
"type": "object",
"description": "With this option, egress site traffic will be routed through an Virtual Private Gateway.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.egress_virtual_private_gateway.vgw_id": {
"type": "string",
"description": "Exclusive with []",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 21,
"pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_internet_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5xc_security_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw": {
"type": "object",
"description": "Two interface AWS ingress/egress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.allowed_vip_port_sli": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw": {
"type": "object",
"description": "Single interface AWS ingress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.instance_type": {
"type": "string",
"description": "Select Instance size based on performance needed.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_worker_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nodes_per_az": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 21,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity": {
"type": "object",
"description": "Private Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.cloud_link": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.total_nodes": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 61,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster": {
"type": "object",
"description": "App Stack cluster of single interface AWS nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.allowed_vip_port": {
"type": "object",
"description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc": {
"type": "object",
"description": "This defines choice about AWS VPC for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc.new_vpc": {
"type": "object",
"description": "Parameters to create new AWS VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vpc.vpc_id": {
"type": "string",
"description": "Exclusive with [new_vpc]\nInformation about existing VPC ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.deployment": [
"aws_cred"
],
"spec.direct_connect_choice": [
"direct_connect_disabled",
"direct_connect_enabled",
"private_connectivity"
],
"spec.egress_gateway_choice": [
"egress_gateway_default",
"egress_nat_gw",
"egress_virtual_private_gateway"
],
"spec.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.security_group_choice": [
"custom_security_group",
"f5xc_security_group"
],
"spec.site_type": [
"ingress_egress_gw",
"ingress_gw",
"voltstack_cluster"
],
"spec.worker_nodes": [
"no_worker_nodes",
"nodes_per_az",
"total_nodes"
],
"spec.direct_connect_enabled.asn_choice": [
"auto_asn",
"custom_asn"
],
"spec.direct_connect_enabled.vif_choice": [
"hosted_vifs",
"standard_vifs"
],
"spec.direct_connect_enabled.hosted_vifs.connectivity_options": [
"site_registration_over_direct_connect",
"site_registration_over_internet"
],
"spec.egress_nat_gw.choice": [
"nat_gw_id"
],
"spec.egress_virtual_private_gateway.choice": [
"vgw_id"
],
"spec.ingress_egress_gw.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.ingress_egress_gw.allowed_vip_port_sli.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.ingress_egress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_gw.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.ingress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.private_connectivity.network_options": [
"inside",
"outside"
],
"spec.voltstack_cluster.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster.allowed_vip_port.port_choice": [
"custom_ports",
"disable_allowed_vip_port",
"use_http_https_port",
"use_http_port",
"use_https_port"
],
"spec.vpc.choice": [
"new_vpc",
"vpc_id"
],
"spec.vpc.new_vpc.name_choice": [
"autogenerate",
"name_tag"
]
}
},
{
"name": "list_aws_vpc_sites",
"description": "List Configure AWS VPC Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/aws_vpc_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_aws_vpc_site",
"description": "DELETE Configure AWS VPC Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/aws_vpc_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a aws_vpc_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_vpc_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_vpc_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
}
},
{
"name": "get_aws_vpc_site",
"description": "GET AWS VPC site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/aws_vpc_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"azure-vnet-sites": {
"name": "azure-vnet-sites",
"displayName": "Azure Vnet Sites",
"operations": [
{
"name": "create_azure_vnet_site",
"description": "Create Azure VNet site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/azure_vnet_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of azure_vnet_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.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/viewsazure_vnet_siteCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Azure Virtual Network CE site for deploying F5 XC nodes in Azure",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.azure_region",
"spec.resource_group",
"spec.azure_cred",
"spec.vnet",
"spec.ssh_key"
      ],
"mutually_exclusive_groups": [
{
"name": "vnet_choice",
"fields": [
"spec.vnet.new_vnet",
"spec.vnet.existing_vnet"
],
"reason": "Create new VNet or use existing"
},
{
"name": "deployment",
"fields": [
"spec.ingress_gw",
"spec.ingress_egress_gw",
"spec.voltstack_cluster"
],
"reason": "Choose site deployment type (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-azure-site\n  namespace: system\nspec:\n  azure_region: eastus2\n  resource_group: example-resource-group\n  azure_cred:\n    name: example-azure-cred\n    namespace: system\n  vnet:\n    new_vnet:\n      name: example-vnet\n      primary_ipv4: \"10.0.0.0/16\"\n  ingress_gw:\n    azure_certified_hw: azure-byol-voltmesh\n    az_nodes:\n      - azure_az: \"1\"\n        local_subnet:\n          subnet_param:\n            ipv4: \"10.0.1.0/24\"\n  ssh_key: \"ssh-rsa AAAA... user@host\"\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-azure-site\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"azure_region\": \"eastus2\",\n    \"resource_group\": \"example-resource-group\",\n    \"azure_cred\": {\"name\": \"example-azure-cred\", \"namespace\": \"system\"},\n    \"vnet\": {\"new_vnet\": {\"name\": \"example-vnet\", \"primary_ipv4\": \"10.0.0.0/16\"}},\n    \"ingress_gw\": {\n      \"azure_certified_hw\": \"azure-byol-voltmesh\",\n      \"az_nodes\": [{\"azure_az\": \"1\", \"local_subnet\": {\"subnet_param\": {\"ipv4\": \"10.0.1.0/24\"}}}]\n    },\n    \"ssh_key\": \"ssh-rsa AAAA... user@host\"\n  }\n}\n"
      },
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-azure-site",
"namespace": "system"
},
"spec": {
"azure_region": "eastus2",
"resource_group": "example-resource-group",
"azure_cred": {
"name": "example-azure-cred",
"namespace": "system"
},
"vnet": {
"new_vnet": {
"name": "example-vnet",
"primary_ipv4": "10.0.0.0/16"
}
},
"ingress_gw": {
"azure_certified_hw": "azure-byol-voltmesh",
"az_nodes": [
{
"azure_az": "1",
"local_subnet": {
"subnet_param": {
"ipv4": "10.0.1.0/24"
}
}
}
]
},
"ssh_key": "ssh-rsa AAAA... user@host"
      }
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.azure_region",
"spec.resource_group",
"spec.azure_cred",
"spec.vnet",
"spec.ssh_key"
      ],
"description": "Azure Virtual Network CE site for deploying F5 XC nodes in Azure"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Azure VNet site specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.alternate_region": {
"type": "string",
"description": "Exclusive with [azure_region]\nName of the Azure region which does not support availability zones.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_cred.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_region": {
"type": "string",
"description": "Exclusive with [alternate_region]\nName of the Azure region which supports availability zones.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_encryption": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disk_size": {
"type": "integer",
"description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 4095,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_encryption": {
"type": "object",
"description": "Information related to disk encryption.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_encryption.disk_encryption_set_id": {
"type": "string",
"description": "Azure Disk Encryption Set to be used to encrypt the disk attached to the VM.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_encryption.resource_group": {
"type": "string",
"description": "The resource group in which the Disk Encryption Set is present.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw": {
"type": "object",
"description": "Two interface Azure ingress/egress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.accelerated_networking": {
"type": "object",
"description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.azure_certified_hw": {
"type": "string",
"description": "Name for Azure certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.hub": {
"type": "object",
"description": "Hub VNet type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.not_hub": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar": {
"type": "object",
"description": "Two interface Azure ingress/egress site on Alternate Region with no support for zones.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.accelerated_networking": {
"type": "object",
"description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.azure_certified_hw": {
"type": "string",
"description": "Name for Azure certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.hub": {
"type": "object",
"description": "Hub VNet type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.node": {
"type": "object",
"description": "Parameters for creating two interface Node in one AZ.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.not_hub": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw": {
"type": "object",
"description": "Single interface Azure ingress site on on Recommended Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.accelerated_networking": {
"type": "object",
"description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.azure_certified_hw": {
"type": "string",
"description": "Name for Azure certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar": {
"type": "object",
"description": "Single interface Azure ingress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar.accelerated_networking": {
"type": "object",
"description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar.azure_certified_hw": {
"type": "string",
"description": "Name for Azure certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar.node": {
"type": "object",
"description": "Parameters for creating Single interface Node for Alternate Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.machine_type": {
"type": "string",
"description": "Select Instance size based on performance needed.\nThe default setting for Accelerated Networking is enabled, thus make sure\nyou select a Virtual Machine that supports accelerated networking or\ndisable the setting under, Select Ingress Gateway or Ingress/Egress Gateway\n> advanced OPTIONS.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_worker_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nodes_per_az": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 21,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.resource_group": {
"type": "string",
"description": "Azure resource group for resources that will be created.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tags": {
"type": "object",
"description": "Azure Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in Azure console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.total_nodes": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 61,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vnet": {
"type": "object",
"description": "This defines choice about Azure VNet for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vnet.existing_vnet": {
"type": "object",
"description": "Resource group and name of existing Azure VNet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vnet.new_vnet": {
"type": "object",
"description": "Parameters to create a new Azure VNet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster": {
"type": "object",
"description": "App Stack Cluster of single interface Azure nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.accelerated_networking": {
"type": "object",
"description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.azure_certified_hw": {
"type": "string",
"description": "Name for Azure certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.default_storage": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar": {
"type": "object",
"description": "App Stack Cluster of single interface Azure nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.accelerated_networking": {
"type": "object",
"description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.azure_certified_hw": {
"type": "string",
"description": "Name for Azure certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.default_storage": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.node": {
"type": "object",
"description": "Parameters for creating Single interface Node for Alternate Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.deployment": [
"azure_cred"
],
"spec.encryption_choice": [
"disable_encryption",
"enable_encryption"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.region_choice": [
"alternate_region",
"azure_region"
],
"spec.site_type": [
"ingress_egress_gw",
"ingress_egress_gw_ar",
"ingress_gw",
"ingress_gw_ar",
"voltstack_cluster",
"voltstack_cluster_ar"
],
"spec.worker_nodes": [
"no_worker_nodes",
"nodes_per_az",
"total_nodes"
],
"spec.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.ingress_egress_gw.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw.hub_choice": [
"hub",
"not_hub"
],
"spec.ingress_egress_gw.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw.accelerated_networking.accelerated_networking": [
"disable",
"enable"
],
"spec.ingress_egress_gw.hub.express_route_choice": [
"express_route_disabled",
"express_route_enabled"
],
"spec.ingress_egress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_egress_gw_ar.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw_ar.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw_ar.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw_ar.hub_choice": [
"hub",
"not_hub"
],
"spec.ingress_egress_gw_ar.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw_ar.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw_ar.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw_ar.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw_ar.accelerated_networking.accelerated_networking": [
"disable",
"enable"
],
"spec.ingress_egress_gw_ar.hub.express_route_choice": [
"express_route_disabled",
"express_route_enabled"
],
"spec.ingress_egress_gw_ar.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_gw.accelerated_networking.accelerated_networking": [
"disable",
"enable"
],
"spec.ingress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_gw_ar.accelerated_networking.accelerated_networking": [
"disable",
"enable"
],
"spec.ingress_gw_ar.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
],
"spec.vnet.choice": [
"existing_vnet",
"new_vnet"
],
"spec.vnet.existing_vnet.routing_type": [
"f5_orchestrated_routing",
"manual_routing"
],
"spec.vnet.new_vnet.name_choice": [
"autogenerate",
"name"
],
"spec.voltstack_cluster.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster.storage_class_choice": [
"default_storage",
"storage_class_list"
],
"spec.voltstack_cluster.accelerated_networking.accelerated_networking": [
"disable",
"enable"
],
"spec.voltstack_cluster_ar.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster_ar.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster_ar.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster_ar.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster_ar.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster_ar.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster_ar.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster_ar.storage_class_choice": [
"default_storage",
"storage_class_list"
],
"spec.voltstack_cluster_ar.accelerated_networking.accelerated_networking": [
"disable",
"enable"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_azure_vnet_site",
"description": "Replace Azure VNet site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/azure_vnet_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a azure_vnet_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsazure_vnet_siteReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Azure Virtual Network CE site for deploying F5 XC nodes in Azure",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.azure_region",
"spec.resource_group",
"spec.azure_cred",
"spec.vnet",
"spec.ssh_key"
      ],
"mutually_exclusive_groups": [
{
"name": "vnet_choice",
"fields": [
"spec.vnet.new_vnet",
"spec.vnet.existing_vnet"
],
"reason": "Create new VNet or use existing"
},
{
"name": "deployment",
"fields": [
"spec.ingress_gw",
"spec.ingress_egress_gw",
"spec.voltstack_cluster"
],
"reason": "Choose site deployment type (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-azure-site\n  namespace: system\nspec:\n  azure_region: eastus2\n  resource_group: example-resource-group\n  azure_cred:\n    name: example-azure-cred\n    namespace: system\n  vnet:\n    new_vnet:\n      name: example-vnet\n      primary_ipv4: \"10.0.0.0/16\"\n  ingress_gw:\n    azure_certified_hw: azure-byol-voltmesh\n    az_nodes:\n      - azure_az: \"1\"\n        local_subnet:\n          subnet_param:\n            ipv4: \"10.0.1.0/24\"\n  ssh_key: \"ssh-rsa AAAA... user@host\"\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-azure-site\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"azure_region\": \"eastus2\",\n    \"resource_group\": \"example-resource-group\",\n    \"azure_cred\": {\"name\": \"example-azure-cred\", \"namespace\": \"system\"},\n    \"vnet\": {\"new_vnet\": {\"name\": \"example-vnet\", \"primary_ipv4\": \"10.0.0.0/16\"}},\n    \"ingress_gw\": {\n      \"azure_certified_hw\": \"azure-byol-voltmesh\",\n      \"az_nodes\": [{\"azure_az\": \"1\", \"local_subnet\": {\"subnet_param\": {\"ipv4\": \"10.0.1.0/24\"}}}]\n    },\n    \"ssh_key\": \"ssh-rsa AAAA... user@host\"\n  }\n}\n"
      },
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-azure-site",
"namespace": "system"
},
"spec": {
"azure_region": "eastus2",
"resource_group": "example-resource-group",
"azure_cred": {
"name": "example-azure-cred",
"namespace": "system"
},
"vnet": {
"new_vnet": {
"name": "example-vnet",
"primary_ipv4": "10.0.0.0/16"
}
},
"ingress_gw": {
"azure_certified_hw": "azure-byol-voltmesh",
"az_nodes": [
{
"azure_az": "1",
"local_subnet": {
"subnet_param": {
"ipv4": "10.0.1.0/24"
}
}
}
]
},
"ssh_key": "ssh-rsa AAAA... user@host"
      }
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.azure_region",
"spec.resource_group",
"spec.azure_cred",
"spec.vnet",
"spec.ssh_key"
      ],
"description": "Azure Virtual Network CE site for deploying F5 XC nodes in Azure"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Azure VNet site replace specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.alternate_region": {
"type": "string",
"description": "Exclusive with [azure_region]\nName of the Azure region which does not support availability zones.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_cred.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_region": {
"type": "string",
"description": "Exclusive with [alternate_region]\nName of the Azure region which supports availability zones.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disk_size": {
"type": "integer",
"description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 4095,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw": {
"type": "object",
"description": "Two interface Azure ingress/egress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.hub": {
"type": "object",
"description": "Hub VNet type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.not_hub": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar": {
"type": "object",
"description": "Two interface Azure ingress/egress site for Alternate Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.hub": {
"type": "object",
"description": "Hub VNet type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.node": {
"type": "object",
"description": "Parameters for creating two interface Node in one AZ.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.not_hub": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw_ar.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw": {
"type": "object",
"description": "Single interface Azure ingress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar": {
"type": "object",
"description": "Single interface Azure ingress site for Alternate Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw_ar.node": {
"type": "object",
"description": "Parameters for creating Single interface Node for Alternate Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.machine_type": {
"type": "string",
"description": "Select Instance size based on performance needed.\nThe default setting for Accelerated Networking is enabled, thus make sure\nyou select a Virtual Machine that supports accelerated networking or\ndisable the setting under, Select Ingress Gateway or Ingress/Egress Gateway\n> advanced OPTIONS.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_worker_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nodes_per_az": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 21,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.resource_group": {
"type": "string",
"description": "Azure resource group for resources that will be created.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.total_nodes": {
"type": "integer",
"description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 61,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vnet": {
"type": "object",
"description": "This defines choice about Azure VNet for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vnet.existing_vnet": {
"type": "object",
"description": "Resource group and name of existing Azure VNet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vnet.new_vnet": {
"type": "object",
"description": "Parameters to create a new Azure VNet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster": {
"type": "object",
"description": "App Stack cluster of single interface Azure nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.az_nodes": {
"type": "array",
"description": "Only Single AZ or Three AZ(s) nodes are supported currently.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar": {
"type": "object",
"description": "App Stack cluster of single interface Azure nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.node": {
"type": "object",
"description": "Parameters for creating Single interface Node for Alternate Region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster_ar.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.deployment": [
"azure_cred"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.region_choice": [
"alternate_region",
"azure_region"
],
"spec.site_type": [
"ingress_egress_gw",
"ingress_egress_gw_ar",
"ingress_gw",
"ingress_gw_ar",
"voltstack_cluster",
"voltstack_cluster_ar"
],
"spec.worker_nodes": [
"no_worker_nodes",
"nodes_per_az",
"total_nodes"
],
"spec.ingress_egress_gw.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw.hub_choice": [
"hub",
"not_hub"
],
"spec.ingress_egress_gw.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw.hub.express_route_choice": [
"express_route_disabled",
"express_route_enabled"
],
"spec.ingress_egress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_egress_gw_ar.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw_ar.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw_ar.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw_ar.hub_choice": [
"hub",
"not_hub"
],
"spec.ingress_egress_gw_ar.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw_ar.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw_ar.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw_ar.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw_ar.hub.express_route_choice": [
"express_route_disabled",
"express_route_enabled"
],
"spec.ingress_egress_gw_ar.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.vnet.choice": [
"existing_vnet",
"new_vnet"
],
"spec.vnet.existing_vnet.routing_type": [
"f5_orchestrated_routing",
"manual_routing"
],
"spec.vnet.new_vnet.name_choice": [
"autogenerate",
"name"
],
"spec.voltstack_cluster.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster_ar.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster_ar.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster_ar.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster_ar.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster_ar.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster_ar.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster_ar.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
]
}
},
{
"name": "list_azure_vnet_sites",
"description": "List Configure Azure VNet Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/azure_vnet_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_azure_vnet_site",
"description": "DELETE Configure Azure VNet Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/azure_vnet_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a azure_vnet_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for azure_vnet_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for azure_vnet_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
}
},
{
"name": "get_azure_vnet_site",
"description": "GET Azure VNet site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/azure_vnet_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bgp-asn-sets": {
"name": "bgp-asn-sets",
"displayName": "Bgp Asn Sets",
"operations": [
{
"name": "create_bgp_asn_set",
"description": "Create BGP ASN Set.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/bgp_asn_sets",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bgp_asn_set",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bgp_asn_set.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/bgp_asn_setCreateSpecType"
}
],
"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 bgp_asn_setCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgp_asn_setCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bgp_asn_setCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create bgp_asn_set creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.as_numbers": {
"type": "array",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create whitelists or blacklists for use in network policy or service policy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_bgp_asn_set",
"description": "Replace BGP ASN Set.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/bgp_asn_sets/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bgp_asn_set",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bgp_asn_set.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/bgp_asn_setReplaceSpecType"
}
],
"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 bgp_asn_setReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgp_asn_setReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bgp_asn_setReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace bgp_asn_set replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.as_numbers": {
"type": "array",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create whitelists or blacklists for use in network policy or service policy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_bgp_asn_sets",
"description": "List BGP ASN Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgp_asn_sets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_bgp_asn_set",
"description": "DELETE BGP ASN Set.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/bgp_asn_sets/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a bgp_asn_set",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bgp_asn_set.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bgp_asn_setDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgp_asn_setDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_bgp_asn_set",
"description": "GET BGP ASN Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgp_asn_sets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bgp-peer-status": {
"name": "bgp-peer-status",
"displayName": "Bgp Peer Status",
"operations": [
{
"name": "create_bgp_peer_statu",
"description": "BGP Peer Status.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/infraprotect/bgp_peer_status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET routed DDoS BGP peer status information.",
"title": "BGP Peer Status Request",
"x-displayname": "BGP Peer Status Request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.BGPPeerStatusRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"time": {
"type": "string",
"description": "Timestamp at which the snapshot of the BGP peer status data should be fetched.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "Time",
"x-displayname": "Time",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Timestamp at which the snapshot of the BGP peer status data should be fetched.",
"x-f5xc-description-medium": "Timestamp at which the snapshot of the BGP peer status data should be fetched. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 8,
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"format": "time",
"formatDescription": "Time format (e.g., 14:30:00)",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET routed DDoS BGP peer status information.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectBGPPeerStatusRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectBGPPeerStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectBGPPeerStatusRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time": {
"type": "string",
"description": "Timestamp at which the snapshot of the BGP peer status data should be fetched.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 8,
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"format": "time",
"formatDescription": "Time format (e.g., 14:30:00)",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "BGP Peer Status Items contains routed DDoS BGP peer status data for each router/peer combination."
}
]
}
]
},
	"bgp-routing-policys": {
"name": "bgp-routing-policys",
"displayName": "Bgp Routing Policys",
"operations": [
{
"name": "create_bgp_routing_policy",
"description": "Create BGP Routing Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/bgp_routing_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bgp_routing_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bgp_routing_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemabgp_routing_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bgp_routing_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgp_routing_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bgp_routing_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "BGP Routing Policy is a list of rules containing match criteria\nand action to be applied. These rules help control routes which are\nimported or exported to BGP peers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "A BGP Routing policy is composed of one or more rules. Note that the order\nof rules is critical as rules are applied top to bottom.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_bgp_routing_policy",
"description": "Replace BGP Routing Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/bgp_routing_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bgp_routing_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bgp_routing_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemabgp_routing_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bgp_routing_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgp_routing_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bgp_routing_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "BGP Routing Policy is a list of rules containing match criteria\nand action to be applied. These rules help control routes which are\nimported or exported to BGP peers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "A BGP Routing policy is composed of one or more rules. Note that the order\nof rules is critical as rules are applied top to bottom.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_bgp_routing_policys",
"description": "List BGP Routing Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgp_routing_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_bgp_routing_policy",
"description": "DELETE BGP Routing Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/bgp_routing_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a bgp_routing_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bgp_routing_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bgp_routing_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgp_routing_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_bgp_routing_policy",
"description": "GET BGP Routing Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgp_routing_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bgps": {
"name": "bgps",
"displayName": "Bgps",
"operations": [
{
"name": "create_bgp",
"description": "Create BGP.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/bgps",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bgp",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bgp.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/bgpCreateSpecType"
}
],
"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 bgpCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgpCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bgpCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "BGP object is the configuration for peering with external BGP servers.\nIt is created by users in system namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters": {
"type": "object",
"description": "BGP parameters for the local site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters.asn": {
"type": "integer",
"description": "Autonomous System Number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.bgp_parameters.from_site": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters.ip_address": {
"type": "string",
"description": "Exclusive with [from_site local_address]\nUse the configured IPv4 Address as Router ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 7,
"pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$",
"format": "ipv4",
"formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters.local_address": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.peers": {
"type": "array",
"description": "List of peers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "VirtualSiteSiteRefSelector defines a union of reference to site or reference to virtual_site\nIt used to refer site or a group of sites indicated by virtual site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.bgp_parameters.router_id_choice": [
"from_site",
"ip_address",
"local_address"
],
"spec.where.ref_or_selector": [
"site",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_bgp",
"description": "Replace BGP.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/bgps/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bgp",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bgp.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/bgpReplaceSpecType"
}
],
"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 bgpReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgpReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bgpReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "BGP object is the configuration for peering with external BGP servers.\nReplace BGP will replace the contents of given BGP object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters": {
"type": "object",
"description": "BGP parameters for the local site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters.asn": {
"type": "integer",
"description": "Autonomous System Number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.bgp_parameters.from_site": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters.ip_address": {
"type": "string",
"description": "Exclusive with [from_site local_address]\nUse the configured IPv4 Address as Router ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 7,
"pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$",
"format": "ipv4",
"formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_parameters.local_address": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.peers": {
"type": "array",
"description": "List of peers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "VirtualSiteSiteRefSelector defines a union of reference to site or reference to virtual_site\nIt used to refer site or a group of sites indicated by virtual site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.bgp_parameters.router_id_choice": [
"from_site",
"ip_address",
"local_address"
],
"spec.where.ref_or_selector": [
"site",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
}
},
{
"name": "list_bgps",
"description": "List BGP",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgps",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_bgp",
"description": "DELETE BGP.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/bgps/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a bgp",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bgp.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bgpDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bgpDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_bgp",
"description": "GET BGP",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgps/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bgpstatus": {
"name": "bgpstatus",
"displayName": "Bgpstatus",
"operations": [
{
"name": "get_bgpstatu",
"description": "GET BGP Status for view.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bgpstatus/{view_name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "view_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "view_kind",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
}
]
}
]
},
	"bigip-http-proxys": {
"name": "bigip-http-proxys",
"displayName": "Bigip Http Proxys",
"operations": [
{
"name": "create_bigip_http_proxy",
"description": "Create BIG-IP HTTP Proxy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/bigip_http_proxys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bigip_http_proxy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.bigip_http_proxy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsbigip_http_proxyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bigip_http_proxyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_http_proxyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bigip_http_proxyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create BIG-IP HTTP Proxy in a given namespace. If one already exists, it will give an error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_profile": {
"type": "object",
"description": "This defines various advanced Profile OPTIONS for a Loadbalancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_profile.disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_profile.enable_default_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile": {
"type": "object",
"description": "BIG-IP DDoS Protection Rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.disable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.enable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules": {
"type": "object",
"description": "IRules Configuration for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules.irules": {
"type": "array",
"description": "OPTIONS for attaching iRules to BIG-IP HTTP Proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm": {
"type": "object",
"description": "Load Balancing Algorithm Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm.round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools": {
"type": "object",
"description": "List of Origin Pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools.pools": {
"type": "array",
"description": "List of Origin Pools.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement": {
"type": "object",
"description": "Proxy Advertisement Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config": {
"type": "object",
"description": "HTTP/HTTPS Load balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config.domains": {
"type": "array",
"description": "A list of domains (host/authority header) that will be matched to loadbalancer.\nWildcard hosts are supported in the suffix or prefix form\n\nDomain search order:\n1. Exact domain names: ``www.example.com``.\n2. Prefix domain wildcards: ``*.example.com`` or ``*-bar.example.com``.\n3. Special wildcard ``*`` matching any domain.\n\nWildcard will not match empty string.\nE.g. ``*-bar.example.com`` will match ``baz-bar.example.com`` but not ``-bar.example.com``.\nThe longest wildcards match first.\n\nDomains are also used for SNI matching if the loadbalancer type is HTTPS\nDomains also indicate the list of names for which DNS resolution will be done by VER.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.proxy_config.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config.https": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config.https_auto_cert": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advanced_profile.choice": [
"disable",
"enable_default_profile"
],
"spec.ddos_profile.ddos_mitigation_choice": [
"disable_ddos_mitigation",
"enable_ddos_mitigation"
],
"spec.lb_algorithm.lb_algorithm_choice": [
"round_robin"
],
"spec.proxy_advertisement.advertise_choice": [
"advertise_custom",
"do_not_advertise"
],
"spec.proxy_config.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"spec.proxy_config.http.port_choice": [
"port",
"port_ranges"
],
"spec.proxy_config.https.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.proxy_config.https.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.proxy_config.https.port_choice": [
"port",
"port_ranges"
],
"spec.proxy_config.https.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.proxy_config.https.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.proxy_config.https_auto_cert.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.proxy_config.https_auto_cert.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.proxy_config.https_auto_cert.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.proxy_config.https_auto_cert.port_choice": [
"port",
"port_ranges"
],
"spec.proxy_config.https_auto_cert.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_bigip_http_proxy",
"description": "Replace BIG-IP HTTP Proxy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/bigip_http_proxys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bigip_http_proxy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.bigip_http_proxy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsbigip_http_proxyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bigip_http_proxyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_http_proxyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bigip_http_proxyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace BIG-IP HTTP Proxy in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_profile": {
"type": "object",
"description": "This defines various advanced Profile OPTIONS for a Loadbalancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_profile.disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_profile.enable_default_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile": {
"type": "object",
"description": "BIG-IP DDoS Protection Rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.disable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.enable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules": {
"type": "object",
"description": "IRules Configuration for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules.irules": {
"type": "array",
"description": "OPTIONS for attaching iRules to BIG-IP HTTP Proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm": {
"type": "object",
"description": "Load Balancing Algorithm Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm.round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools": {
"type": "object",
"description": "List of Origin Pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools.pools": {
"type": "array",
"description": "List of Origin Pools.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement": {
"type": "object",
"description": "Proxy Advertisement Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config": {
"type": "object",
"description": "HTTP/HTTPS Load balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config.domains": {
"type": "array",
"description": "A list of domains (host/authority header) that will be matched to loadbalancer.\nWildcard hosts are supported in the suffix or prefix form\n\nDomain search order:\n1. Exact domain names: ``www.example.com``.\n2. Prefix domain wildcards: ``*.example.com`` or ``*-bar.example.com``.\n3. Special wildcard ``*`` matching any domain.\n\nWildcard will not match empty string.\nE.g. ``*-bar.example.com`` will match ``baz-bar.example.com`` but not ``-bar.example.com``.\nThe longest wildcards match first.\n\nDomains are also used for SNI matching if the loadbalancer type is HTTPS\nDomains also indicate the list of names for which DNS resolution will be done by VER.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.proxy_config.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config.https": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_config.https_auto_cert": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advanced_profile.choice": [
"disable",
"enable_default_profile"
],
"spec.ddos_profile.ddos_mitigation_choice": [
"disable_ddos_mitigation",
"enable_ddos_mitigation"
],
"spec.lb_algorithm.lb_algorithm_choice": [
"round_robin"
],
"spec.proxy_advertisement.advertise_choice": [
"advertise_custom",
"do_not_advertise"
],
"spec.proxy_config.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"spec.proxy_config.http.port_choice": [
"port",
"port_ranges"
],
"spec.proxy_config.https.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.proxy_config.https.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.proxy_config.https.port_choice": [
"port",
"port_ranges"
],
"spec.proxy_config.https.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.proxy_config.https.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.proxy_config.https_auto_cert.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.proxy_config.https_auto_cert.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.proxy_config.https_auto_cert.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.proxy_config.https_auto_cert.port_choice": [
"port",
"port_ranges"
],
"spec.proxy_config.https_auto_cert.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
]
}
},
{
"name": "list_bigip_http_proxys",
"description": "List Configure BIG-IP HTTP Proxy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bigip_http_proxys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_bigip_http_proxy",
"description": "DELETE Configure BIG-IP HTTP Proxy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/bigip_http_proxys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a bigip_http_proxy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.bigip_http_proxy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bigip_http_proxyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_http_proxyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
}
},
{
"name": "get_bigip_http_proxy",
"description": "GET BIG-IP HTTP Proxy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bigip_http_proxys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bigip-virtual-servers": {
"name": "bigip-virtual-servers",
"displayName": "Bigip Virtual Servers",
"operations": [
{
"name": "replace_bigip_virtual_server",
"description": "Replace BIG-IP virtual server.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/bigip_virtual_servers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bigip_virtual_server",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.bigip_virtual_server.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/viewsbigip_virtual_serverReplaceSpecType"
}
],
"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 bigip_virtual_serverReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_virtual_serverReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bigip_virtual_serverReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the BIG-IP virtual server specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification": {
      "type": "object",
"description": "Settings for API specification (API definition, OpenAPI validation, etc.)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_all_spec_endpoints": {
      "type": "object",
"description": "Settings for API Inventory validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_custom_list": {
      "type": "object",
"description": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.\nAny other API-endpoint not listed will act according to \"Fall Through Mode\".",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sensitive_data_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_definition": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery": {
      "type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_crawler": {
      "type": "object",
"description": "API Crawler message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_discovery_from_code_scan": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.custom_api_auth_discovery": {
      "type": "object",
"description": "API Discovery Advanced settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.default_api_auth_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.disable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.enable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "object",
"description": "Settings for data type policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy.sensitive_data_policy_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.api_definition_choice": [
      "api_specification",
      "disable_api_definition"
      ],
"spec.api_discovery_choice": [
      "disable_api_discovery",
      "enable_api_discovery"
      ],
"spec.sensitive_data_policy_choice": [
"default_sensitive_data_policy",
"sensitive_data_policy"
],
"spec.api_specification.validation_target_choice": [
      "validation_all_spec_endpoints",
"validation_custom_list",
"validation_disabled"
],
"spec.api_specification.validation_all_spec_endpoints.oversized_body_choice": [],
      "spec.api_specification.validation_custom_list.oversized_body_choice": [],
      "spec.enable_api_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.enable_api_discovery.learn_from_redirect_traffic": [
      "disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.enable_api_discovery.api_crawler.api_crawler": [
      "api_crawler_config",
      "disable_api_crawler"
      ]
}
},
{
"name": "list_bigip_virtual_servers",
"description": "List BIG-IP virtual server.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bigip_virtual_servers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_bigip_virtual_server",
"description": "GET BIG-IP virtual server.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bigip_virtual_servers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bigipconnector": {
"name": "bigipconnector",
"displayName": "Bigipconnector",
"operations": [
{
"name": "create_bigipconnector",
"description": "Specification.",
"method": "POST",
"path": "/api/bigipconnector/namespaces/{namespace}/bigip_irules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bigip_irule",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bigip_irule.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/bigip_iruleCreateSpecType"
}
],
"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 bigip_iruleCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_iruleCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bigip_iruleCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Desired state for BIG-IP iRule Service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code": {
"type": "string",
"description": "IRule code content, this content will be base64 encoded for preserving formatting.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1048576,
"byteLength": {
"max": 1048576,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.irule_name": {
"type": "string",
"description": "IRule name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.source": {
"type": "string",
"description": "IRule generation/updation source.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_bigipconnector",
"description": "Specification.",
"method": "PUT",
"path": "/api/bigipconnector/namespaces/{namespace}/bigip_irules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bigip_irule",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bigip_irule.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/bigip_iruleReplaceSpecType"
}
],
"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 bigip_iruleReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_iruleReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bigip_iruleReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Desired state for BIG-IP iRule Service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code": {
"type": "string",
"description": "IRule code content, this content will be base64 encoded for preserving formatting.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1048576,
"byteLength": {
"max": 1048576,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.irule_name": {
"type": "string",
"description": "IRule name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.source": {
"type": "string",
"description": "IRule generation/updation source.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_bigipconnector",
"description": "List BIG-IP iRule as a Service.",
"method": "GET",
"path": "/api/bigipconnector/namespaces/{namespace}/bigip_irules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_bigipconnector",
"description": "DELETE BIG-IP iRule as a Service.",
"method": "DELETE",
"path": "/api/bigipconnector/namespaces/{namespace}/bigip_irules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a bigip_irule",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bigip_irule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bigip_iruleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_iruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
}
},
{
"name": "get_bigipconnector",
"description": "Specification.",
"method": "GET",
"path": "/api/bigipconnector/namespaces/{namespace}/bigip_irules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bigipconnector-applications-discovered": {
"name": "bigipconnector-applications-discovered",
"displayName": "Bigipconnector Applications Discovered",
"operations": [
{
"name": "list_bigipconnector_applications_discovered",
"description": "List",
"method": "GET",
"path": "/api/bigipconnector/namespaces/{namespace}/uztna/applications/discovered",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
}
]
},
	"billing-usage-details": {
"name": "billing-usage-details",
"displayName": "Billing Usage Details",
"operations": [
{
"name": "create_billing_usage_detail",
"description": "Telemetry Data Metrics.",
"method": "POST",
"path": "/api/data/namespaces/system/billing/usage_details",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to GET billing usage details for the given tenant.",
"title": "Billing Usage Details Request",
"x-displayname": "Billing Usage Details Request.",
"x-ves-proto-message": "ves.io.schema.billing.BillingUsageDetailsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+1h\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+1h If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "array",
"description": "List of usage_type queries and the corresponding object/namespace filters.",
"title": "Name",
"items": {
"$ref": "#/components/schemas/billingUsageDataFilter"
},
"x-displayname": "Usage Data Filter.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "List of usage_type queries and the corresponding object/namespace filters.",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-1h\nIf end_time is not specified, then the start_time will be evaluated to <current time>-1h.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-1h If end_time is not specified, then the start_time will be evaluated to <current time>-1h.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET billing usage details for the given tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for billingBillingUsageDetailsRequest",
"required_fields": [
"filters"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for billingBillingUsageDetailsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  filters: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"filters\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
},
"usage_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"filters": "value"
}
},
"requiredFields": [
"filters"
],
"description": "Minimum configuration for billingBillingUsageDetailsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+1h\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "array",
"description": "List of usage_type queries and the corresponding object/namespace filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-1h\nIf end_time is not specified, then the start_time will be evaluated to <current time>-1h.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
},
{
"field": "usage_data",
"type": "array",
"description": "Data contains time-series data for the billing usage."
}
]
}
]
},
	"billing-usage-summary": {
"name": "billing-usage-summary",
"displayName": "Billing Usage Summary",
"operations": [
{
"name": "create_billing_usage_summary",
"description": "Billing Usage Summary.",
"method": "POST",
"path": "/api/data/namespaces/system/billing/usage_summary",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Time interval to GET the billing usage summary.",
"title": "Billing Usage Summary Request",
"x-displayname": "Billing Usage Summary Request.",
"x-ves-proto-message": "ves.io.schema.billing.BillingUsageSummaryRequest",
"properties": {
"end_time": {
"type": "string",
"description": "Fetch alerts whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time + 6 hours\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time + 6 hours If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch billing usage summary for timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time - 6 hours\nIf end_time is not specified, then the start_time will be evaluated to <current time> - 6 hours.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch billing usage summary for timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch billing usage summary for timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time - 6 hours If end_time is not specified, then the start_time will be evaluated to <current time> - 6 hours.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Time interval to GET the billing usage summary.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for billingBillingUsageSummaryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for billingBillingUsageSummaryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"usage_summary_items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for billingBillingUsageSummaryRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "Fetch alerts whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time + 6 hours\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch billing usage summary for timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time - 6 hours\nIf end_time is not specified, then the start_time will be evaluated to <current time> - 6 hours.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "usage_summary_items",
"type": "array",
"description": "Configuration parameter for usage summary items"
}
]
}
]
},
	"block-client-suggestion": {
"name": "block-client-suggestion",
"displayName": "Block Client Suggestion",
"operations": [
{
"name": "create_block_client_suggestion",
"description": "Suggest block client rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/block_client/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested blocking SimpleClientSrcRule for a given IP/ASN.",
"title": "GetSuggestedBlockClientRuleReq",
"x-displayname": "GET Suggested Block Client Rule Request.",
"x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedBlockClientRuleReq",
"properties": {
"as_description": {
"type": "string",
"description": "AS description.",
"title": "Description",
"maxLength": 256,
"x-displayname": "AS Description.",
"x-ves-example": "As-description.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "as-description",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"as_number": {
"type": "integer",
"description": "RFC 6793 defined 4-byte AS number.",
"title": "as number",
"format": "int64",
"x-displayname": "AS Number",
"x-ves-example": "4683",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "401308"
},
"x-f5xc-example": "4683",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "401308"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 401308,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ip_prefix": {
"type": "string",
"description": "IP prefix string.",
"title": "ip prefix",
"x-displayname": "IP Prefix",
"x-ves-example": "192.0.2.0/24.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.ip_prefix": "true"
},
"x-f5xc-example": "192.0.2.0/24",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.ip_prefix": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "cidr",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this WAF exclusion will be applied.",
"title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this WAF exclusion will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"user_id": {
"type": "string",
"description": "User ID of blocked client.",
"title": "user id",
"maxLength": 256,
"x-displayname": "User ID",
"x-ves-example": "Abc",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "abc",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "GET suggested blocking SimpleClientSrcRule for a given IP/ASN.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedBlockClientRuleReq",
"required_fields": [
"as_number",
"ip_prefix"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedBlockClientRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  as_number: value\n  ip_prefix: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"as_number\": \"value\",\n    \"ip_prefix\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"as_number": "value",
"ip_prefix": "value"
}
},
"requiredFields": [
"as_number",
"ip_prefix"
],
"description": "Minimum configuration for app_securityGetSuggestedBlockClientRuleReq"
},
"fieldMetadata": {
"as_description": {
"type": "string",
"description": "AS description.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"as_number": {
"type": "integer",
"description": "RFC 6793 defined 4-byte AS number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 401308,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ip_prefix": {
"type": "string",
"description": "IP prefix string.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "cidr",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this WAF exclusion will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_id": {
"type": "string",
"description": "User ID of blocked client.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "HTTP load balancer for which this WAF exclusion will be applied."
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"bot-defense-app-infrastructures": {
"name": "bot-defense-app-infrastructures",
"displayName": "Bot Defense App Infrastructures",
"operations": [
{
"name": "create_bot_defense_app_infrastructure",
"description": "Create Bot Defense App Infrastructure.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bot_defense_app_infrastructure",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.bot_defense_app_infrastructure.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/bot_defense_app_infrastructureCreateSpecType"
}
],
"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 bot_defense_app_infrastructureCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_defense_app_infrastructureCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bot_defense_app_infrastructureCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates Bot Defense App Infrastructure in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_hosted": {
"type": "object",
"description": "Infra F5 Hosted.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_hosted.egress": {
"type": "array",
"description": "Egress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_hosted.infra_host_name": {
"type": "string",
"description": "Infra Host Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_hosted.ingress": {
"type": "array",
"description": "Ingress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_hosted.region": {
"type": "string",
"description": "Defines a selection for Bot Defense Advanced region\n\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"spec.data_center_hosted": {
"type": "object",
"description": "Infra F5 Hosted.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.data_center_hosted.egress": {
"type": "array",
"description": "Egress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.data_center_hosted.infra_host_name": {
"type": "string",
"description": "Infra Host Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.data_center_hosted.ingress": {
"type": "array",
"description": "Ingress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.data_center_hosted.region": {
"type": "string",
"description": "Defines a selection for Bot Defense Advanced region\n\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"spec.environment_type": {
"type": "string",
"description": "Environment Type\n\nProduction environment\nTesting environment.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRODUCTION"
},
"spec.traffic_type": {
"type": "string",
"description": "Traffic Type\n\nWeb traffic\nMobile traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "WEB"
}
},
"oneOfVariants": {
"spec.infra_choice": [
"cloud_hosted",
"data_center_hosted"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_bot_defense_app_infrastructure",
"description": "Replace Bot Defense App Infrastructure.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bot_defense_app_infrastructure",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.bot_defense_app_infrastructure.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/bot_defense_app_infrastructureReplaceSpecType"
}
],
"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 bot_defense_app_infrastructureReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_defense_app_infrastructureReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bot_defense_app_infrastructureReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a given Bot Defense App Infrastructure in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_hosted": {
"type": "object",
"description": "Infra F5 Hosted.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_hosted.egress": {
"type": "array",
"description": "Egress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_hosted.infra_host_name": {
"type": "string",
"description": "Infra Host Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_hosted.ingress": {
"type": "array",
"description": "Ingress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_hosted.region": {
"type": "string",
"description": "Defines a selection for Bot Defense Advanced region\n\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"spec.data_center_hosted": {
"type": "object",
"description": "Infra F5 Hosted.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.data_center_hosted.egress": {
"type": "array",
"description": "Egress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.data_center_hosted.infra_host_name": {
"type": "string",
"description": "Infra Host Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.data_center_hosted.ingress": {
"type": "array",
"description": "Ingress",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.data_center_hosted.region": {
"type": "string",
"description": "Defines a selection for Bot Defense Advanced region\n\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"spec.environment_type": {
"type": "string",
"description": "Environment Type\n\nProduction environment\nTesting environment.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRODUCTION"
},
"spec.traffic_type": {
"type": "string",
"description": "Traffic Type\n\nWeb traffic\nMobile traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "WEB"
}
},
"oneOfVariants": {
"spec.infra_choice": [
"cloud_hosted",
"data_center_hosted"
]
}
},
{
"name": "list_bot_defense_app_infrastructures",
"description": "List Bot Defense App Infrastructure.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_bot_defense_app_infrastructure",
"description": "DELETE Bot Defense App Infrastructure.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a bot_defense_app_infrastructure",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.bot_defense_app_infrastructure.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bot_defense_app_infrastructureDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_defense_app_infrastructureDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
}
},
{
"name": "get_bot_defense_app_infrastructure",
"description": "Bot Defense App Infrastructure.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"bulk-revoke-api-credentials": {
"name": "bulk-revoke-api-credentials",
      "displayName": "Bulk Revoke Api Credentials",
      "operations": [
{
"name": "create_bulk_revoke_api_credential",
      "description": "Bulk Revoke API credentials.",
      "method": "POST",
"path": "/api/web/namespaces/system/bulk_revoke/api_credentials",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request format for revoking multiple API credentials.",
      "title": "Bulk Revoke Request",
"x-displayname": "Bulk Revoke Request.",
"x-ves-oneof-field-bulkrevoke_choice": "[\"expired_selector\",\"name_selector\"]",
"x-ves-proto-message": "ves.io.schema.api_credential.BulkRevokeRequest",
      "properties": {
"expired_selector": {
"allOf": [
{
"$ref": "#/components/schemas/api_credentialExpiredSelector"
      }
],
"x-f5xc-description-short": "Configuration parameter for expired selector.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name_selector": {
"allOf": [
{
"$ref": "#/components/schemas/api_credentialNameSelector"
      }
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request format for revoking multiple API credentials.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_credentialBulkRevokeRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_credentialBulkRevokeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"credentials_failed": {
      "type": "array"
},
"credentials_marked_for_deletion": {
      "type": "array"
},
"error_message": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for api_credentialBulkRevokeRequest"
      },
"fieldMetadata": {
"expired_selector": {
"type": "object",
"description": "It specifies which expired credentials needs to be deleted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"expired_selector.all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"expired_selector.credential_type": {
      "type": "string",
"description": "Types of API credential given when requesting credentials from F5 Distributed Cloud\n\nF5XC user certificate to access F5XC public API using mTLS\nusing self credential (my credential)\nKubernetes config file to access Virtual Kubernetes API in F5 Distributed Cloud\nusing self credential (my credential)\nAPI token to access F5XC public API\nusing self credential (my credential)\nAPI token for service credentials\nusing service user credential (service credential)\nAPI certificate for service credentials\nusing service user credential (service credential)\nService Credential kubeconfig\nusing service user credential (service credential)\nKubeconfig for accessing Site via Global Controller\nusing self credential (my credential)\nToken for the SCIM public APIs used to sync users and groups with the F5XC platform.\nExternal identity provider's SCIM client can use this token as Bearer token with Authorization header\nService Credential Kubeconfig for accessing Site via Global Controller\nusing service user credential (service credential)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "API_CERTIFICATE"
      },
"name_selector": {
"type": "object",
"description": "Revoke Credentials by their names.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name_selector.names": {
"type": "array",
"description": "It contains the names of credentials which needs to be deleted.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 200,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"bulkrevoke_choice": [
"expired_selector",
"name_selector"
],
"expired_selector.expired_credential_choice": [
      "all",
"credential_type"
      ]
},
"responseSummary": [
{
"field": "credentials_failed",
      "type": "array",
"description": "Names of credentials that are not marked as DELETE due to some error."
      },
{
"field": "credentials_marked_for_deletion",
      "type": "array",
"description": "Names of credentials that are successfully marked for deletion."
      },
{
"field": "error_message",
"type": "string",
"description": "Error message about the failures of bulk revoke of credentials."
      }
]
}
]
},
	"bulk-revoke-service-credentials": {
"name": "bulk-revoke-service-credentials",
      "displayName": "Bulk Revoke Service Credentials",
      "operations": [
{
"name": "create_bulk_revoke_service_credential",
      "description": "Bulk Revoke service credential.",
      "method": "POST",
"path": "/api/web/namespaces/system/bulk_revoke/service_credentials",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request format for revoking multiple API credentials.",
      "title": "Bulk Revoke Request",
"x-displayname": "Bulk Revoke Request.",
"x-ves-oneof-field-bulkrevoke_choice": "[\"expired_selector\",\"name_selector\"]",
"x-ves-proto-message": "ves.io.schema.api_credential.BulkRevokeRequest",
      "properties": {
"expired_selector": {
"allOf": [
{
"$ref": "#/components/schemas/api_credentialExpiredSelector"
      }
],
"x-f5xc-description-short": "Configuration parameter for expired selector.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name_selector": {
"allOf": [
{
"$ref": "#/components/schemas/api_credentialNameSelector"
      }
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request format for revoking multiple API credentials.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_credentialBulkRevokeRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_credentialBulkRevokeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"credentials_failed": {
      "type": "array"
},
"credentials_marked_for_deletion": {
      "type": "array"
},
"error_message": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for api_credentialBulkRevokeRequest"
      },
"fieldMetadata": {
"expired_selector": {
"type": "object",
"description": "It specifies which expired credentials needs to be deleted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"expired_selector.all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"expired_selector.credential_type": {
      "type": "string",
"description": "Types of API credential given when requesting credentials from F5 Distributed Cloud\n\nF5XC user certificate to access F5XC public API using mTLS\nusing self credential (my credential)\nKubernetes config file to access Virtual Kubernetes API in F5 Distributed Cloud\nusing self credential (my credential)\nAPI token to access F5XC public API\nusing self credential (my credential)\nAPI token for service credentials\nusing service user credential (service credential)\nAPI certificate for service credentials\nusing service user credential (service credential)\nService Credential kubeconfig\nusing service user credential (service credential)\nKubeconfig for accessing Site via Global Controller\nusing self credential (my credential)\nToken for the SCIM public APIs used to sync users and groups with the F5XC platform.\nExternal identity provider's SCIM client can use this token as Bearer token with Authorization header\nService Credential Kubeconfig for accessing Site via Global Controller\nusing service user credential (service credential)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "API_CERTIFICATE"
      },
"name_selector": {
"type": "object",
"description": "Revoke Credentials by their names.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name_selector.names": {
"type": "array",
"description": "It contains the names of credentials which needs to be deleted.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 200,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"bulkrevoke_choice": [
"expired_selector",
"name_selector"
],
"expired_selector.expired_credential_choice": [
      "all",
"credential_type"
      ]
},
"responseSummary": [
{
"field": "credentials_failed",
      "type": "array",
"description": "Names of credentials that are not marked as DELETE due to some error."
      },
{
"field": "credentials_marked_for_deletion",
      "type": "array",
"description": "Names of credentials that are successfully marked for deletion."
      },
{
"field": "error_message",
"type": "string",
"description": "Error message about the failures of bulk revoke of credentials."
      }
]
}
]
},
	"ca-certificate": {
"name": "ca-certificate",
"displayName": "Ca Certificate",
"operations": [
{
"name": "list_ca_certificate",
"description": "GET proxy Server CA Certificate.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/proxys/{name}/ca_certificate",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"cascade-delete": {
"name": "cascade-delete",
"displayName": "Cascade Delete",
"operations": [
{
"name": "create_cascade_delete",
"description": "Cascade DELETE.",
"method": "POST",
"path": "/api/web/namespaces/{name}/cascade_delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "CascadeDeleteRequest contains the name of the namespace that has to be deleted\nalong with the objects configured under the namespace.",
"title": "CascadeDeleteRequest",
"x-displayname": "Cascade DELETE Request.",
"x-ves-proto-message": "ves.io.schema.namespace.CascadeDeleteRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the namespace.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "CascadeDeleteRequest contains the name of the namespace that has to be deleted along with the objects configured under the namespace.",
"x-f5xc-description-medium": "CascadeDeleteRequest contains the name of the namespace that has to be deleted along with the objects configured under the namespace.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceCascadeDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceCascadeDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceCascadeDeleteRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "The objects deleted in namespace."
}
]
}
]
},
	"catalogs": {
"name": "catalogs",
"displayName": "Catalogs",
"operations": [
{
"name": "replace_catalog",
"description": "List",
"method": "PUT",
"path": "/api/web/namespaces/system/catalogs",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "List request message. Includes optional filter.",
"title": "ListRequest",
"x-displayname": "ListRequest.",
"x-ves-oneof-field-filter": "[\"use_case_filter\",\"workspace_filter\"]",
"x-ves-proto-message": "ves.io.schema.pbac.catalog.ListRequest",
"properties": {
"use_case_filter": {
"type": "string",
"description": "Exclusive with [workspace_filter]\nFilter by use case name. If empty, all use cases are returned.",
"title": "Use case filter",
"x-displayname": "Use case Filter.",
"x-ves-example": "F5xc-base",
"x-f5xc-example": "f5xc-base",
"x-f5xc-description-short": "Exclusive with [workspace_filter] Filter by use case name. If empty, all use cases are returned.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"workspace_filter": {
"type": "string",
"description": "Exclusive with [use_case_filter]\nFilter by workspace name. If empty, all workspaces are returned.\nThe use case response field will contain the use case of the workspace and no other use cases.",
"title": "Workspace Filter",
"x-displayname": "Workspace Filter.",
"x-ves-example": "F5xc-base",
"x-f5xc-example": "f5xc-base",
"x-f5xc-description-short": "Exclusive with [use_case_filter] Filter by workspace name. If empty, all workspaces are returned.",
"x-f5xc-description-medium": "Exclusive with [use_case_filter] Filter by workspace name. If empty, all workspaces are returned. The use case response field will contain the use case of the workspace and no other use cases.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "List request message. Includes optional filter.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for catalogListRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for catalogListRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"addon_services": {
"type": "object"
},
"services": {
"type": "object"
},
"system_management": {
"type": "object"
},
"use_cases": {
"type": "object"
},
"workspaces": {
"type": "object"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for catalogListRequest"
},
"fieldMetadata": {
"use_case_filter": {
"type": "string",
"description": "Exclusive with [workspace_filter]\nFilter by use case name. If empty, all use cases are returned.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"workspace_filter": {
"type": "string",
"description": "Exclusive with [use_case_filter]\nFilter by workspace name. If empty, all workspaces are returned.\nThe use case response field will contain the use case of the workspace and no other use cases.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"filter": [
"use_case_filter",
"workspace_filter"
]
},
"responseSummary": [
{
"field": "addon_services",
"type": "object",
"description": "List of Addon Services. The key is the addon service name."
      },
{
"field": "services",
"type": "object",
"description": "List of result services (addons). The key is the service name."
      },
{
"field": "system_management",
"type": "object",
"description": "List of system management tiles. The key is the workspace name."
      },
{
"field": "use_cases",
"type": "object",
"description": "List of result use cases. The key is the use case name."
      },
{
"field": "workspaces",
"type": "object",
"description": "List of result tiles (workspaces). The key is the workspace name."
      }
]
}
]
},
	"cdn-access-logs": {
"name": "cdn-access-logs",
      "displayName": "Cdn Access Logs",
      "operations": [
{
"name": "create_cdn_access_log",
      "description": "GET CDN Access Logs.",
      "method": "POST",
"path": "/api/cdn/namespaces/{namespace}/cdn_loadbalancer/access_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch access logs.",
      "title": "CDNAccessLogRequest",
      "x-displayname": "CDN Access Log Request.",
      "x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.CDNAccessLogRequest",
      "properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-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.max_pairs": "16"
},
"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.max_pairs": "16"
},
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-f5xc-description-short": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "0",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "0",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch access logs for a given namespace.",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch access logs for a given namespace.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "array",
"description": "CDN Access Logs filter OPTIONS.",
      "title": "Access Logs Filter options",
      "maxItems": 32,
"items": {
"$ref": "#/components/schemas/cdn_loadbalancerCDNAccessLogFilter"
      },
"x-displayname": "Access Logs Filter.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "32"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-f5xc-description-short": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_loadbalancerCDNAccessLogRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerCDNAccessLogRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_loadbalancerCDNAccessLogRequest"
      },
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch access logs for a given namespace.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "array",
"description": "CDN Access Logs filter OPTIONS.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"cdn-access-logs-aggregation": {
"name": "cdn-access-logs-aggregation",
      "displayName": "Cdn Access Logs Aggregation",
      "operations": [
{
"name": "create_cdn_access_logs_aggregation",
      "description": "CDN Access Log Aggregation Query.",
      "method": "POST",
"path": "/api/cdn/namespaces/{namespace}/cdn_loadbalancer/access_logs/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for access logs.",
      "title": "CDNAccessLogAggregationRequest",
      "x-displayname": "CDN Access Log Aggregation Request.",
      "x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.CDNAccessLogAggregationRequest",
      "properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-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.max_pairs": "16"
},
"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.max_pairs": "16"
},
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-f5xc-description-short": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "array",
"description": "CDN Access Logs filter OPTIONS.",
      "title": "Access Logs Filter options",
      "items": {
"$ref": "#/components/schemas/cdn_loadbalancerCDNAccessLogFilter"
      },
"x-displayname": "Access Logs Filter.",
      "x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-f5xc-description-short": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
      "x-f5xc-description-medium": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for access logs.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_loadbalancerCDNAccessLogAggregationRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerCDNAccessLogAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_loadbalancerCDNAccessLogAggregationRequest"
      },
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch access logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "array",
"description": "CDN Access Logs filter OPTIONS.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch access logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"cdn-cache-purge": {
"name": "cdn-cache-purge",
"displayName": "Cdn Cache Purge",
"operations": [
{
"name": "create_cdn_cache_purge",
"description": "Purge CDN Cache.",
"method": "POST",
"path": "/api/cdn/namespaces/{namespace}/cdn_loadbalancer/{name}/cache-purge",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "CDN Cache Purge.",
"title": "Cache Purge Request",
"x-displayname": "Cache Purge.",
"x-ves-oneof-field-pattern_type": "[\"hostname\",\"pattern\",\"purge_all\",\"url\"]",
"x-ves-oneof-field-purge_type": "[\"hard_purge\",\"soft_purge\"]",
"x-ves-proto-message": "ves.io.schema.views.common_cdn.LilacCDNCachePurgeRequest",
"properties": {
"hard_purge": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"hostname": {
"type": "string",
"description": "Exclusive with [pattern purge_all URL]\nPurge cached content by Hostname.",
"title": "Hostname",
"x-displayname": "Hostname",
"x-ves-example": "xyz.com",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.vh_domain": "true"
},
"x-f5xc-example": "xyz.com",
"x-validation-rules": {
"ves.io.schema.rules.string.vh_domain": "true"
},
"x-f5xc-description-short": "Exclusive with [pattern purge_all URL] Purge cached content by Hostname.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "fqdn",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pattern": {
"type": "string",
"description": "Exclusive with [hostname purge_all URL]\nPurge cached content using PCRE 1 compliant regular expression.",
"title": "Regex Pattern to match",
"minLength": 1,
"maxLength": 256,
"x-displayname": "Pattern",
"x-ves-example": ".*\\\\.ts",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": ".*\\\\.ts",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Exclusive with [hostname purge_all URL] Purge cached content using PCRE 1 compliant regular expression.",
"x-f5xc-description-medium": "Exclusive with [hostname purge_all URL] Purge cached content using PCRE 1 compliant regular expression.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"purge_all": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"soft_purge": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"url": {
"type": "string",
"description": "Exclusive with [hostname pattern purge_all]\nPurge cache by using a URL path.",
"title": "URL",
"x-displayname": "URL",
"x-ves-example": "/path1",
"x-f5xc-example": "/path1",
"x-f5xc-description-short": "Exclusive with [hostname pattern purge_all] Purge cache by using a URL path.",
"format": "uri",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+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 common_cdnLilacCDNCachePurgeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for common_cdnLilacCDNCachePurgeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"purge_request_id": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for common_cdnLilacCDNCachePurgeRequest"
},
"fieldMetadata": {
"hard_purge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"hostname": {
"type": "string",
"description": "Exclusive with [pattern purge_all URL]\nPurge cached content by Hostname.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "fqdn",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pattern": {
"type": "string",
"description": "Exclusive with [hostname purge_all URL]\nPurge cached content using PCRE 1 compliant regular expression.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"purge_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"soft_purge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"url": {
"type": "string",
"description": "Exclusive with [hostname pattern purge_all]\nPurge cache by using a URL path.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"pattern_type": [
"hostname",
"pattern",
"purge_all",
"url"
],
"purge_type": [
"hard_purge",
"soft_purge"
]
},
"responseSummary": [
{
"field": "purge_request_id",
"type": "integer",
"description": "Request ID to track the status of the purge request."
}
]
}
]
},
	"cdn-cache-rules": {
"name": "cdn-cache-rules",
"displayName": "Cdn Cache Rules",
"operations": [
{
"name": "create_cdn_cache_rule",
"description": "Create CDN cache rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_cache_rules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cdn_cache_rule",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cdn_cache_rule.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/schemacdn_cache_ruleCreateSpecType"
}
],
"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 cdn_cache_ruleCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_cache_ruleCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_cache_ruleCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the CDN loadbalancer specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules": {
"type": "object",
"description": "This defines a CDN Cache Rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules.cache_bypass": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules.eligible_for_cache": {
"type": "object",
"description": "List of OPTIONS for Cache Action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules.rule_expression_list": {
"type": "array",
"description": "Expressions are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs..",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cache_rules.rule_name": {
"type": "string",
"description": "Name of the Cache Rule.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cache_rules.cache_actions": [
"cache_bypass",
"eligible_for_cache"
],
"spec.cache_rules.eligible_for_cache.eligible_for_cache": [
"scheme_proxy_host_request_uri",
"scheme_proxy_host_uri"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cdn_cache_rule",
"description": "Replace CDN cache rule.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cdn_cache_rules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cdn_cache_rule",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cdn_cache_rule.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/schemacdn_cache_ruleReplaceSpecType"
}
],
"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 cdn_cache_ruleReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_cache_ruleReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_cache_ruleReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the CDN loadbalancer specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules": {
"type": "object",
"description": "This defines a CDN Cache Rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules.cache_bypass": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules.eligible_for_cache": {
"type": "object",
"description": "List of OPTIONS for Cache Action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_rules.rule_expression_list": {
"type": "array",
"description": "Expressions are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs..",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cache_rules.rule_name": {
"type": "string",
"description": "Name of the Cache Rule.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cache_rules.cache_actions": [
"cache_bypass",
"eligible_for_cache"
],
"spec.cache_rules.eligible_for_cache.eligible_for_cache": [
"scheme_proxy_host_request_uri",
"scheme_proxy_host_uri"
]
}
},
{
"name": "list_cdn_cache_rules",
"description": "List CDN cache rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_cache_rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cdn_cache_rule",
"description": "DELETE CDN cache rule.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cdn_cache_rules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cdn_cache_rule",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cdn_cache_rule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_cache_ruleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_cache_ruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
}
},
{
"name": "get_cdn_cache_rule",
"description": "GET CDN cache rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_cache_rules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cdn-get-service-operation-status": {
"name": "cdn-get-service-operation-status",
"displayName": "Cdn Get Service Operation Status",
"operations": [
{
"name": "create_cdn_get_service_operation_statu",
"description": "GET Service Operation Status.",
"method": "POST",
"path": "/api/cdn/namespaces/{namespace}/cdn_loadbalancer/get-service-operation-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET Service Operation Request.",
"title": "Service Operation Request",
"x-displayname": "GET Service Operation Request.",
"x-ves-proto-message": "ves.io.schema.views.common_cdn.GetServiceOperationReq",
"properties": {
"name": {
"type": "string",
"description": "Name of the CDN distribution.\nFormat: string.",
"title": "CDN Distribution Name",
"x-displayname": "Name of the CDN distribution.",
"x-ves-example": "CDN-1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "cdn-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of the CDN distribution. Format: string.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace scope of the operation request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace scope of the operation request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"service_op_id": {
"type": "integer",
"description": "Operation ID for which status is requested.",
"title": "Service Operation ID",
"format": "int64",
"x-displayname": "Service Operation ID.",
"x-ves-example": "101",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "101",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Operation ID for which status is requested.",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for common_cdnGetServiceOperationReq",
"required_fields": [
"name",
"namespace",
"service_op_id"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for common_cdnGetServiceOperationReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  service_op_id: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"service_op_id\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"service_op_id": "value"
}
},
"requiredFields": [
"name",
"namespace",
"service_op_id"
],
"description": "Minimum configuration for common_cdnGetServiceOperationReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the CDN distribution.\nFormat: string.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace scope of the operation request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"service_op_id": {
"type": "integer",
"description": "Operation ID for which status is requested.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
}
]
},
	"cdn-lilac-cdn-addon-subscribe": {
"name": "cdn-lilac-cdn-addon-subscribe",
"displayName": "Cdn Lilac Cdn Addon Subscribe",
"operations": [
{
"name": "create_cdn_lilac_cdn_addon_subscribe",
"description": "Subscribe to CDN Loadbalancer.",
"method": "POST",
"path": "/api/cdn/namespaces/system/lilac-cdn/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to CDN Loadbalancer.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.SubscribeRequest",
"x-f5xc-description-short": "Request to subscribe to CDN Loadbalancer.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_loadbalancerSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_loadbalancerSubscribeRequest"
}
}
]
},
	"cdn-lilac-cdn-addon-unsubscribe": {
"name": "cdn-lilac-cdn-addon-unsubscribe",
"displayName": "Cdn Lilac Cdn Addon Unsubscribe",
"operations": [
{
"name": "create_cdn_lilac_cdn_addon_unsubscribe",
"description": "Unsubscribe to CDN Loadbalancer.",
"method": "POST",
"path": "/api/cdn/namespaces/system/lilac-cdn/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to CDN Loadbalancer.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to CDN Loadbalancer.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_loadbalancerUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_loadbalancerUnsubscribeRequest"
}
}
]
},
	"cdn-list-service-operations-status": {
"name": "cdn-list-service-operations-status",
"displayName": "Cdn List Service Operations Status",
"operations": [
{
"name": "create_cdn_list_service_operations_statu",
"description": "List of CDN Operation Commands.",
"method": "POST",
"path": "/api/cdn/namespaces/{namespace}/cdn_loadbalancer/list-service-operations-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "List Service Operations Request.",
"title": "Service Operations Request",
"x-displayname": "List Service Operations Request.",
"x-ves-oneof-field-options": "[\"lastn\",\"time_range\"]",
"x-ves-proto-message": "ves.io.schema.views.common_cdn.ListServiceOperationsReq",
"properties": {
"lastn": {
"type": "integer",
"description": "Exclusive with [time_range]\nThe last n service operations.",
"title": "lastn",
"format": "int64",
"x-displayname": "Last N",
"x-ves-example": "5",
"x-f5xc-example": "5",
"x-f5xc-description-short": "Exclusive with [time_range] The last n service operations.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the CDN Distribution.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace this item belongs to.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ns1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"time_range": {
"allOf": [
{
"$ref": "#/components/schemas/common_cdnServiceOperationsTimeRange"
}
],
"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 common_cdnListServiceOperationsReq",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for common_cdnListServiceOperationsReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for common_cdnListServiceOperationsReq"
},
"fieldMetadata": {
"lastn": {
"type": "integer",
"description": "Exclusive with [time_range]\nThe last n service operations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the CDN Distribution.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace this item belongs to.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"time_range": {
"type": "object",
"description": "Option to specify lastn or start-end time.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_range.finish_time": {
"type": "string",
"description": "A finish time for the time range in which the service operation status is requested.\nFormat: unix_timestamp|RFC 3339.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"time_range.start_time": {
"type": "string",
"description": "A start time for the time range in which the service operation status is requested.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"options": [
"lastn",
"time_range"
]
},
"responseSummary": [
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
}
]
},
	"cdn-loadbalancers": {
"name": "cdn-loadbalancers",
"displayName": "Cdn Loadbalancers",
"operations": [
{
"name": "create_cdn_loadbalancer",
"description": "Create CDN Loadbalancer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cdn_loadbalancer",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.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/viewscdn_loadbalancerCreateSpecType"
}
],
"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 cdn_loadbalancerCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_loadbalancerCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the CDN loadbalancer specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.api_rate_limit": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.api_endpoint_rules": {
      "type": "array",
"description": "Ordered endpoint-specific rate-limit rules. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.bypass_rate_limiting_rules": {
      "type": "object",
"description": "This category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.custom_ip_allowed_list": {
      "type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.ip_allowed_list": {
      "type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.no_ip_allowed_list": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.server_url_rules": {
      "type": "array",
"description": "Ordered domain or base-path rules for path-scoped rate limiting. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification": {
      "type": "object",
"description": "Settings for API specification (API definition, OpenAPI validation, etc.)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_all_spec_endpoints": {
      "type": "object",
"description": "Settings for API Inventory validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_custom_list": {
      "type": "object",
"description": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.\nAny other API-endpoint not listed will act according to \"Fall Through Mode\".",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_clients": {
"type": "array",
"description": "Define rules to block IP Prefixes or AS numbers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.disable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.enable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.regional_endpoint": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- AUTO: AUTO\n\nAutomatic selection based on client IP address\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AUTO"
},
"spec.bot_defense.timeout": {
"type": "integer",
"description": "The timeout for the inference check, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 60000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.captcha_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy": {
"type": "object",
"description": "Cross-Origin Resource Sharing requests configuration specified at Virtual-host or\nRoute level. Route level configuration takes precedence.\n\nAn example of an Cross origin HTTP request\nGET /resources/public-data/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nReferrer: http://foo.example/examples/access-control/simplexsinvocation.html\nOrigin: http://foo.example\n\nHTTP/1.1 200 OK\nDate: Mon, 01 Dec 2008 00:23:53 GMT\nServer: Apache/2.0.61\nAccess-Control-Allow-Origin: *\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive\nTransfer-Encoding: chunked\nContent-Type: application/XML\n\nAn example for cross origin HTTP OPTIONS request with Access-Control-Request-* header\n\nOPTIONS /resources/POST-here/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nOrigin: http://foo.example\nAccess-Control-Request-Method: POST\nAccess-Control-Request-Headers: X-PINGOTHER, Content-Type\n\nHTTP/1.1 204 No Content\nDate: Mon, 01 Dec 2008 01:15:39 GMT\nServer: Apache/2.0.61 (Unix)\nAccess-Control-Allow-Origin: http://foo.example\nAccess-Control-Allow-Methods: POST, GET, OPTIONS\nAccess-Control-Allow-Headers: X-PINGOTHER, Content-Type\nAccess-Control-Max-Age: 86400\nVary: Accept-Encoding, Origin\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_credentials": {
      "type": "boolean",
"description": "Specifies whether the resource allows credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_headers": {
"type": "string",
"description": "Specifies the content for the access-control-allow-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_methods": {
"type": "string",
"description": "Specifies the content for the access-control-allow-methods header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin": {
"type": "array",
"description": "Specifies the origins that will be allowed to do CORS requests.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin_regex": {
"type": "array",
"description": "Specifies regex patterns that match allowed origins.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.disabled": {
"type": "boolean",
"description": "Disable the CorsPolicy for a particular route. This is useful when\nvirtual-host has CorsPolicy, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.expose_headers": {
"type": "string",
"description": "Specifies the content for the access-control-expose-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.maximum_age": {
"type": "integer",
"description": "Specifies the content for the access-control-max-age header in seconds.\nThis indicates the maximum number of seconds the results can be cached\nA value of -1 will disable caching.\nMaximum permitted value is 86400 seconds (24 hours)",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy": {
"type": "object",
"description": "To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host.\n\n1. The origin that caused the user agent to issue the request (source origin).\n2. The origin that the request is going to (target origin).\nWhen the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid.\nBecause CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.all_load_balancer_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.custom_domain_list": {
"type": "object",
"description": "List of domain names used for Host header matching.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_cache_rule": {
"type": "object",
"description": "Caching policies for CDN.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_cache_rule.cdn_cache_rules": {
"type": "array",
"description": "Reference to CDN Cache Rule configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.data_guard_rules": {
"type": "array",
"description": "Data Guard prevents responses from exposing sensitive information by masking the data.\nThe system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*).\nNote: App Firewall should be enabled, to use Data Guard feature.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_mitigation_rules": {
"type": "array",
"description": "Define manual mitigation rules to block L7 DDoS attacks.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action": {
"type": "object",
"description": "This defines a Default Cache Action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action.cache_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action.cache_ttl_default": {
"type": "string",
"description": "Exclusive with [cache_disabled cache_ttl_override]\nUse Cache TTL Provided by Origin, and set a contigency TTL value in case one is not provided.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action.cache_ttl_override": {
"type": "string",
"description": "Exclusive with [cache_disabled cache_ttl_default]\nAlways override the Cache TTL provided by Origin.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sensitive_data_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_definition": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_client_side_defense": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ip_reputation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_rate_limit": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of fully qualified domain names.\nThe CDN Distribution will be setup for these FQDN name(s).\n[This can be a domain or a sub-domain]",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_api_discovery": {
      "type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_crawler": {
      "type": "object",
"description": "API Crawler message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_discovery_from_code_scan": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.custom_api_auth_discovery": {
      "type": "object",
"description": "API Discovery Advanced settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.default_api_auth_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.disable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.enable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge": {
"type": "object",
"description": "Configure auto mitigation i.e risk based challenges for malicious users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation": {
"type": "object",
"description": "List of IP threat categories.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation.ip_threat_categories": {
"type": "array",
"description": "If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.graphql_rules": {
"type": "array",
"description": "GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable\ndescription of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it\neasier to evolve APIs over time, and enables powerful developer tools. Policy configuration to analyze GraphQL\nqueries and prevent GraphQL tailored attacks.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nAs a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature\nor a DNS CNAME record should be created in your DNS provider's portal.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTP port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https": {
"type": "object",
"description": "Choice for selecting CDN Distribution with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.tls_cert_options": {
"type": "object",
"description": "TLS Certificate OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert": {
"type": "object",
"description": "Choice for selecting HTTPS CDN distribution with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.jwt_validation": {
"type": "object",
"description": "JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming\nJWTs before they are passed to your API origin. JWT Validation will also stop requests with expired\ntokens or tokens that are not yet valid.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.action": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.authorization_server": {
      "type": "object",
"description": "Reference to Authorization Server object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.jwks_config": {
"type": "object",
"description": "The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.mandatory_claims": {
"type": "object",
"description": "Configurable Validation of mandatory Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.reserved_claims": {
"type": "object",
"description": "Configurable Validation of reserved Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.target": {
"type": "object",
"description": "Define endpoints for which JWT token validation will be performed.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.token_location": {
      "type": "object",
"description": "Location of JWT in HTTP request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_block": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool": {
"type": "object",
"description": "Origin Pool for the CDN distribution.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.more_origin_options": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.origin_request_timeout": {
"type": "string",
"description": "Configures the time after which a request to the origin will time out waiting for a response.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.origin_servers": {
"type": "array",
"description": "List of original servers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.origin_pool.public_name": {
"type": "object",
"description": "Specify origin server with public DNS name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.use_tls": {
"type": "object",
"description": "Upstream TLS Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings": {
"type": "object",
"description": "Other Settings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings.add_location": {
"type": "boolean",
"description": "X-example: true\nAppends header x-F5 Distributed Cloud-location = <RE-site-name> in responses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings.header_options": {
"type": "object",
"description": "This defines various OPTIONS related to request/response headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings.logging_options": {
"type": "object",
"description": "This defines various OPTIONS related to logging.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge": {
"type": "object",
"description": "Specifies the settings for policy rule based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_captcha_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_js_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_temporary_blocking_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.rule_list": {
"type": "object",
"description": "List of challenge rules to be used in policy based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.temporary_user_blocking": {
"type": "object",
"description": "Specifies configuration for temporary user blocking resulting from user behavior analysis.\n\nWhen Malicious User Mitigation is enabled from service policy rules, users' accessing the application will be analyzed for\nmalicious activity and the configured mitigation actions will be taken on identified malicious users.\nThese mitigation actions include setting up temporary blocking on that user.\nThis configuration specifies settings on how that blocking should be done by the loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protected_cookies": {
"type": "array",
"description": "Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses.\nCookie Tampering Protection prevents attackers from modifying the value of session cookies.\nFor Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite.\nThe configured mode of WAF (monitoring or blocking) will be enforced on the request when cookie tampering is identified.\nNote: We recommend enabling Secure and HttpOnly attributes along with cookie tampering protection.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.custom_ip_allowed_list": {
"type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.ip_allowed_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_ip_allowed_list": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.policies": {
"type": "object",
"description": "List of rate limiter policies to be applied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.rate_limiter": {
"type": "object",
"description": "A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "object",
"description": "Settings for data type policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy.sensitive_data_policy_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation": {
"type": "object",
"description": "\"Slow and low\" attacks tie up server resources, leaving none available for servicing\nrequests from actual users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.disable_request_timeout": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_headers_timeout": {
"type": "integer",
"description": "The amount of time the client has to send only the headers on the request stream before\nthe stream is cancelled. The default value is 10000 milliseconds. This setting\nprovides protection against Slowloris attacks.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_timeout": {
"type": "integer",
"description": "Exclusive with [disable_request_timeout]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 300000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.system_default_timeouts": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.trusted_clients": {
"type": "array",
"description": "Define rules to skip processing of one or more features such as WAF, Bot Defense etc. For clients.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_id_client_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_inline_rules": {
"type": "object",
"description": "A list of WAF exclusion rules that will be applied inline.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.api_definition_choice": [
      "api_specification",
      "disable_api_definition"
      ],
"spec.api_discovery_choice": [
      "disable_api_discovery",
      "enable_api_discovery"
      ],
"spec.bot_defense_choice": [
"bot_defense"
],
"spec.challenge_type": [
"captcha_challenge",
"enable_challenge",
"js_challenge",
"no_challenge",
"policy_based_challenge"
],
"spec.client_side_defense_choice": [
"client_side_defense",
"disable_client_side_defense"
],
"spec.ip_reputation_choice": [
"disable_ip_reputation",
"enable_ip_reputation"
],
"spec.l7_ddos_auto_mitigation_action": [
"l7_ddos_action_block",
"l7_ddos_action_default",
"l7_ddos_action_js_challenge"
],
"spec.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"spec.malicious_user_detection_choice": [
"disable_malicious_user_detection",
"enable_malicious_user_detection"
],
"spec.rate_limit_choice": [
"api_rate_limit",
      "disable_rate_limit",
"rate_limit"
],
"spec.sensitive_data_policy_choice": [
"default_sensitive_data_policy",
"sensitive_data_policy"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
],
"spec.slow_ddos_mitigation_choice": [
"slow_ddos_mitigation",
"system_default_timeouts"
],
"spec.threat_mesh_choice": [
"disable_threat_mesh",
"enable_threat_mesh"
],
"spec.user_id_choice": [
"user_id_client_ip",
"user_identification"
],
"spec.waf_choice": [
"app_firewall",
"disable_waf"
],
"spec.api_rate_limit.ip_allowed_list_choice": [
      "bypass_rate_limiting_rules",
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.api_specification.validation_target_choice": [
      "validation_all_spec_endpoints",
"validation_custom_list",
"validation_disabled"
],
"spec.api_specification.validation_all_spec_endpoints.oversized_body_choice": [],
      "spec.api_specification.validation_custom_list.oversized_body_choice": [],
      "spec.bot_defense.cors_support_choice": [
"disable_cors_support",
"enable_cors_support"
],
"spec.bot_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.bot_defense.policy.mobile_sdk_choice": [
"disable_mobile_sdk",
"mobile_sdk_config"
],
"spec.client_side_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.csrf_policy.allowed_domains": [
"all_load_balancer_domains",
"custom_domain_list",
"disabled"
],
"spec.default_cache_action.cache_actions": [
"cache_disabled",
"cache_ttl_default",
"cache_ttl_override"
],
"spec.enable_api_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.enable_api_discovery.learn_from_redirect_traffic": [
      "disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.enable_api_discovery.api_crawler.api_crawler": [
      "api_crawler_config",
      "disable_api_crawler"
      ],
"spec.enable_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.enable_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.enable_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.http.port_choice": [
"port",
"port_ranges"
],
"spec.https.tls_cert_options.tls_certificates_choice": [
"tls_cert_params",
"tls_inline_params"
],
"spec.https_auto_cert.tls_config.choice": [
"tls_11_plus",
"tls_12_plus"
],
"spec.jwt_validation.jwks_configuration": [
"authorization_server",
      "jwks_config"
],
"spec.jwt_validation.action.action_choice": [
"block",
"report"
],
"spec.jwt_validation.reserved_claims.audience_validation": [
"audience",
"audience_disable"
],
"spec.jwt_validation.reserved_claims.issuer_validation": [
"issuer",
"issuer_disable"
],
"spec.jwt_validation.reserved_claims.validate_period": [
"validate_period_disable",
"validate_period_enable"
],
"spec.jwt_validation.target.target": [
"all_endpoint",
"api_groups",
      "base_paths"
],
"spec.jwt_validation.token_location.token_location": [
      "bearer_token"
      ],
"spec.origin_pool.tls_choice": [
"no_tls",
"use_tls"
],
"spec.origin_pool.use_tls.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.origin_pool.use_tls.mtls_choice": [
"no_mtls",
"use_mtls",
"use_mtls_obj"
],
"spec.origin_pool.use_tls.server_validation_choice": [
"skip_server_verification",
"use_server_verification",
"volterra_trusted_ca"
],
"spec.origin_pool.use_tls.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.policy_based_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.policy_based_challenge.challenge_choice": [
"always_enable_captcha_challenge",
"always_enable_js_challenge",
"no_challenge"
],
"spec.policy_based_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.policy_based_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.policy_based_challenge.temporary_blocking_parameters_choice": [
"default_temporary_blocking_parameters",
"temporary_user_blocking"
],
"spec.rate_limit.ip_allowed_list_choice": [
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.rate_limit.policy_choice": [
"no_policies",
"policies"
],
"spec.rate_limit.rate_limiter.action_choice": [
"action_block",
"disabled"
],
"spec.rate_limit.rate_limiter.algorithm": [
"leaky_bucket",
"token_bucket"
      ],
"spec.slow_ddos_mitigation.request_timeout_choice": [
"disable_request_timeout",
"request_timeout"
],
"spec.waf_exclusion.waf_exclusion_choice": [
"waf_exclusion_inline_rules",
"waf_exclusion_policy"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cdn_loadbalancer",
"description": "Replace CDN Loadbalancer.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cdn_loadbalancer",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.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/viewscdn_loadbalancerReplaceSpecType"
}
],
"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 cdn_loadbalancerReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_loadbalancerReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the CDN loadbalancer specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.api_rate_limit": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.api_endpoint_rules": {
      "type": "array",
"description": "Ordered endpoint-specific rate-limit rules. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.bypass_rate_limiting_rules": {
      "type": "object",
"description": "This category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.custom_ip_allowed_list": {
      "type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.ip_allowed_list": {
      "type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.no_ip_allowed_list": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.server_url_rules": {
      "type": "array",
"description": "Ordered domain or base-path rules for path-scoped rate limiting. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification": {
      "type": "object",
"description": "Settings for API specification (API definition, OpenAPI validation, etc.)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_all_spec_endpoints": {
      "type": "object",
"description": "Settings for API Inventory validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_custom_list": {
      "type": "object",
"description": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.\nAny other API-endpoint not listed will act according to \"Fall Through Mode\".",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_clients": {
"type": "array",
"description": "Define rules to block IP Prefixes or AS numbers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.disable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.enable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.regional_endpoint": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- AUTO: AUTO\n\nAutomatic selection based on client IP address\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AUTO"
},
"spec.bot_defense.timeout": {
"type": "integer",
"description": "The timeout for the inference check, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 60000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.captcha_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy": {
"type": "object",
"description": "Cross-Origin Resource Sharing requests configuration specified at Virtual-host or\nRoute level. Route level configuration takes precedence.\n\nAn example of an Cross origin HTTP request\nGET /resources/public-data/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nReferrer: http://foo.example/examples/access-control/simplexsinvocation.html\nOrigin: http://foo.example\n\nHTTP/1.1 200 OK\nDate: Mon, 01 Dec 2008 00:23:53 GMT\nServer: Apache/2.0.61\nAccess-Control-Allow-Origin: *\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive\nTransfer-Encoding: chunked\nContent-Type: application/XML\n\nAn example for cross origin HTTP OPTIONS request with Access-Control-Request-* header\n\nOPTIONS /resources/POST-here/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nOrigin: http://foo.example\nAccess-Control-Request-Method: POST\nAccess-Control-Request-Headers: X-PINGOTHER, Content-Type\n\nHTTP/1.1 204 No Content\nDate: Mon, 01 Dec 2008 01:15:39 GMT\nServer: Apache/2.0.61 (Unix)\nAccess-Control-Allow-Origin: http://foo.example\nAccess-Control-Allow-Methods: POST, GET, OPTIONS\nAccess-Control-Allow-Headers: X-PINGOTHER, Content-Type\nAccess-Control-Max-Age: 86400\nVary: Accept-Encoding, Origin\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_credentials": {
      "type": "boolean",
"description": "Specifies whether the resource allows credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_headers": {
"type": "string",
"description": "Specifies the content for the access-control-allow-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_methods": {
"type": "string",
"description": "Specifies the content for the access-control-allow-methods header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin": {
"type": "array",
"description": "Specifies the origins that will be allowed to do CORS requests.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin_regex": {
"type": "array",
"description": "Specifies regex patterns that match allowed origins.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.disabled": {
"type": "boolean",
"description": "Disable the CorsPolicy for a particular route. This is useful when\nvirtual-host has CorsPolicy, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.expose_headers": {
"type": "string",
"description": "Specifies the content for the access-control-expose-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.maximum_age": {
"type": "integer",
"description": "Specifies the content for the access-control-max-age header in seconds.\nThis indicates the maximum number of seconds the results can be cached\nA value of -1 will disable caching.\nMaximum permitted value is 86400 seconds (24 hours)",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy": {
"type": "object",
"description": "To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host.\n\n1. The origin that caused the user agent to issue the request (source origin).\n2. The origin that the request is going to (target origin).\nWhen the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid.\nBecause CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.all_load_balancer_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.custom_domain_list": {
"type": "object",
"description": "List of domain names used for Host header matching.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_cache_rule": {
"type": "object",
"description": "Caching policies for CDN.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_cache_rule.cdn_cache_rules": {
"type": "array",
"description": "Reference to CDN Cache Rule configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.data_guard_rules": {
"type": "array",
"description": "Data Guard prevents responses from exposing sensitive information by masking the data.\nThe system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*).\nNote: App Firewall should be enabled, to use Data Guard feature.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_mitigation_rules": {
"type": "array",
"description": "Define manual mitigation rules to block L7 DDoS attacks.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action": {
"type": "object",
"description": "This defines a Default Cache Action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action.cache_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action.cache_ttl_default": {
"type": "string",
"description": "Exclusive with [cache_disabled cache_ttl_override]\nUse Cache TTL Provided by Origin, and set a contigency TTL value in case one is not provided.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_cache_action.cache_ttl_override": {
"type": "string",
"description": "Exclusive with [cache_disabled cache_ttl_default]\nAlways override the Cache TTL provided by Origin.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sensitive_data_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_definition": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_client_side_defense": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ip_reputation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_rate_limit": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of fully qualified domain names.\nThe CDN Distribution will be setup for these FQDN name(s).\n[This can be a domain or a sub-domain]",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_api_discovery": {
      "type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_crawler": {
      "type": "object",
"description": "API Crawler message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_discovery_from_code_scan": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.custom_api_auth_discovery": {
      "type": "object",
"description": "API Discovery Advanced settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.default_api_auth_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.disable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.enable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge": {
"type": "object",
"description": "Configure auto mitigation i.e risk based challenges for malicious users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation": {
"type": "object",
"description": "List of IP threat categories.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation.ip_threat_categories": {
"type": "array",
"description": "If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.graphql_rules": {
"type": "array",
"description": "GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable\ndescription of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it\neasier to evolve APIs over time, and enables powerful developer tools. Policy configuration to analyze GraphQL\nqueries and prevent GraphQL tailored attacks.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nAs a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature\nor a DNS CNAME record should be created in your DNS provider's portal.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTP port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https": {
"type": "object",
"description": "Choice for selecting CDN Distribution with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.tls_cert_options": {
"type": "object",
"description": "TLS Certificate OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert": {
"type": "object",
"description": "Choice for selecting HTTPS CDN distribution with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.jwt_validation": {
"type": "object",
"description": "JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming\nJWTs before they are passed to your API origin. JWT Validation will also stop requests with expired\ntokens or tokens that are not yet valid.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.action": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.authorization_server": {
      "type": "object",
"description": "Reference to Authorization Server object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.jwks_config": {
"type": "object",
"description": "The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.mandatory_claims": {
"type": "object",
"description": "Configurable Validation of mandatory Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.reserved_claims": {
"type": "object",
"description": "Configurable Validation of reserved Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.target": {
"type": "object",
"description": "Define endpoints for which JWT token validation will be performed.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.token_location": {
      "type": "object",
"description": "Location of JWT in HTTP request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_block": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool": {
"type": "object",
"description": "Origin Pool for the CDN distribution.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.more_origin_options": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.origin_request_timeout": {
"type": "string",
"description": "Configures the time after which a request to the origin will time out waiting for a response.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.origin_servers": {
"type": "array",
"description": "List of original servers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.origin_pool.public_name": {
"type": "object",
"description": "Specify origin server with public DNS name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pool.use_tls": {
"type": "object",
"description": "Upstream TLS Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings": {
"type": "object",
"description": "Other Settings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings.add_location": {
"type": "boolean",
"description": "X-example: true\nAppends header x-F5 Distributed Cloud-location = <RE-site-name> in responses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings.header_options": {
"type": "object",
"description": "This defines various OPTIONS related to request/response headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.other_settings.logging_options": {
"type": "object",
"description": "This defines various OPTIONS related to logging.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge": {
"type": "object",
"description": "Specifies the settings for policy rule based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_captcha_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_js_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_temporary_blocking_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.rule_list": {
"type": "object",
"description": "List of challenge rules to be used in policy based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.temporary_user_blocking": {
"type": "object",
"description": "Specifies configuration for temporary user blocking resulting from user behavior analysis.\n\nWhen Malicious User Mitigation is enabled from service policy rules, users' accessing the application will be analyzed for\nmalicious activity and the configured mitigation actions will be taken on identified malicious users.\nThese mitigation actions include setting up temporary blocking on that user.\nThis configuration specifies settings on how that blocking should be done by the loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protected_cookies": {
"type": "array",
"description": "Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses.\nCookie Tampering Protection prevents attackers from modifying the value of session cookies.\nFor Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite.\nThe configured mode of WAF (monitoring or blocking) will be enforced on the request when cookie tampering is identified.\nNote: We recommend enabling Secure and HttpOnly attributes along with cookie tampering protection.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.custom_ip_allowed_list": {
"type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.ip_allowed_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_ip_allowed_list": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.policies": {
"type": "object",
"description": "List of rate limiter policies to be applied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.rate_limiter": {
"type": "object",
"description": "A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "object",
"description": "Settings for data type policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy.sensitive_data_policy_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation": {
"type": "object",
"description": "\"Slow and low\" attacks tie up server resources, leaving none available for servicing\nrequests from actual users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.disable_request_timeout": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_headers_timeout": {
"type": "integer",
"description": "The amount of time the client has to send only the headers on the request stream before\nthe stream is cancelled. The default value is 10000 milliseconds. This setting\nprovides protection against Slowloris attacks.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_timeout": {
"type": "integer",
"description": "Exclusive with [disable_request_timeout]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 300000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.system_default_timeouts": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.trusted_clients": {
"type": "array",
"description": "Define rules to skip processing of one or more features such as WAF, Bot Defense etc. For clients.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_id_client_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_inline_rules": {
"type": "object",
"description": "A list of WAF exclusion rules that will be applied inline.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.api_definition_choice": [
      "api_specification",
      "disable_api_definition"
      ],
"spec.api_discovery_choice": [
      "disable_api_discovery",
      "enable_api_discovery"
      ],
"spec.bot_defense_choice": [
"bot_defense"
],
"spec.challenge_type": [
"captcha_challenge",
"enable_challenge",
"js_challenge",
"no_challenge",
"policy_based_challenge"
],
"spec.client_side_defense_choice": [
"client_side_defense",
"disable_client_side_defense"
],
"spec.ip_reputation_choice": [
"disable_ip_reputation",
"enable_ip_reputation"
],
"spec.l7_ddos_auto_mitigation_action": [
"l7_ddos_action_block",
"l7_ddos_action_default",
"l7_ddos_action_js_challenge"
],
"spec.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"spec.malicious_user_detection_choice": [
"disable_malicious_user_detection",
"enable_malicious_user_detection"
],
"spec.rate_limit_choice": [
"api_rate_limit",
      "disable_rate_limit",
"rate_limit"
],
"spec.sensitive_data_policy_choice": [
"default_sensitive_data_policy",
"sensitive_data_policy"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
],
"spec.slow_ddos_mitigation_choice": [
"slow_ddos_mitigation",
"system_default_timeouts"
],
"spec.threat_mesh_choice": [
"disable_threat_mesh",
"enable_threat_mesh"
],
"spec.user_id_choice": [
"user_id_client_ip",
"user_identification"
],
"spec.waf_choice": [
"app_firewall",
"disable_waf"
],
"spec.api_rate_limit.ip_allowed_list_choice": [
      "bypass_rate_limiting_rules",
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.api_specification.validation_target_choice": [
      "validation_all_spec_endpoints",
"validation_custom_list",
"validation_disabled"
],
"spec.api_specification.validation_all_spec_endpoints.oversized_body_choice": [],
      "spec.api_specification.validation_custom_list.oversized_body_choice": [],
      "spec.bot_defense.cors_support_choice": [
"disable_cors_support",
"enable_cors_support"
],
"spec.bot_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.bot_defense.policy.mobile_sdk_choice": [
"disable_mobile_sdk",
"mobile_sdk_config"
],
"spec.client_side_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.csrf_policy.allowed_domains": [
"all_load_balancer_domains",
"custom_domain_list",
"disabled"
],
"spec.default_cache_action.cache_actions": [
"cache_disabled",
"cache_ttl_default",
"cache_ttl_override"
],
"spec.enable_api_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.enable_api_discovery.learn_from_redirect_traffic": [
      "disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.enable_api_discovery.api_crawler.api_crawler": [
      "api_crawler_config",
      "disable_api_crawler"
      ],
"spec.enable_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.enable_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.enable_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.http.port_choice": [
"port",
"port_ranges"
],
"spec.https.tls_cert_options.tls_certificates_choice": [
"tls_cert_params",
"tls_inline_params"
],
"spec.https_auto_cert.tls_config.choice": [
"tls_11_plus",
"tls_12_plus"
],
"spec.jwt_validation.jwks_configuration": [
"authorization_server",
      "jwks_config"
],
"spec.jwt_validation.action.action_choice": [
"block",
"report"
],
"spec.jwt_validation.reserved_claims.audience_validation": [
"audience",
"audience_disable"
],
"spec.jwt_validation.reserved_claims.issuer_validation": [
"issuer",
"issuer_disable"
],
"spec.jwt_validation.reserved_claims.validate_period": [
"validate_period_disable",
"validate_period_enable"
],
"spec.jwt_validation.target.target": [
"all_endpoint",
"api_groups",
      "base_paths"
],
"spec.jwt_validation.token_location.token_location": [
      "bearer_token"
      ],
"spec.origin_pool.tls_choice": [
"no_tls",
"use_tls"
],
"spec.origin_pool.use_tls.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.origin_pool.use_tls.mtls_choice": [
"no_mtls",
"use_mtls",
"use_mtls_obj"
],
"spec.origin_pool.use_tls.server_validation_choice": [
"skip_server_verification",
"use_server_verification",
"volterra_trusted_ca"
],
"spec.origin_pool.use_tls.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.policy_based_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.policy_based_challenge.challenge_choice": [
"always_enable_captcha_challenge",
"always_enable_js_challenge",
"no_challenge"
],
"spec.policy_based_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.policy_based_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.policy_based_challenge.temporary_blocking_parameters_choice": [
"default_temporary_blocking_parameters",
"temporary_user_blocking"
],
"spec.rate_limit.ip_allowed_list_choice": [
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.rate_limit.policy_choice": [
"no_policies",
"policies"
],
"spec.rate_limit.rate_limiter.action_choice": [
"action_block",
"disabled"
],
"spec.rate_limit.rate_limiter.algorithm": [
"leaky_bucket",
"token_bucket"
      ],
"spec.slow_ddos_mitigation.request_timeout_choice": [
"disable_request_timeout",
"request_timeout"
],
"spec.waf_exclusion.waf_exclusion_choice": [
"waf_exclusion_inline_rules",
"waf_exclusion_policy"
]
}
},
{
"name": "list_cdn_loadbalancers",
"description": "List CDN Loadbalancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cdn_loadbalancer",
"description": "DELETE CDN Loadbalancer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cdn_loadbalancer",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_loadbalancerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
}
},
{
"name": "get_cdn_loadbalancer",
"description": "GET CDN Loadbalancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cdn-metrics": {
"name": "cdn-metrics",
"displayName": "Cdn Metrics",
"operations": [
{
"name": "create_cdn_metric",
"description": "GET CDN Metrics.",
"method": "POST",
"path": "/api/cdn/namespaces/{namespace}/cdn_loadbalancer/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "CDN Metrics request parameters.",
"title": "Metrics Request parameters",
"x-displayname": "Metrics Request.",
"x-ves-proto-message": "ves.io.schema.views.cdn_loadbalancer.LilacCDNMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "Format: unix_timestamp|RFC 3339.",
"title": "End Time",
"x-displayname": "End Time",
"x-ves-example": "1659758607.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1659758607",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Fields (Metrics) selected to be queried.",
"title": "Field Selector",
"maxItems": 10,
"items": {
"$ref": "#/components/schemas/cdn_loadbalancerLilacCDNMetricsFieldSelector"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "10"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "10"
},
"x-f5xc-description-short": "Fields (Metrics) selected to be queried.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 10,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "array",
"description": "CDN Metrics filter OPTIONS.",
"title": "Metrics Filter options",
"items": {
"$ref": "#/components/schemas/cdn_loadbalancerLilacCDNMetricsFilter"
},
"x-displayname": "Metrics Filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more tags.",
"title": "Group By",
"items": {
"$ref": "#/components/schemas/cdn_loadbalancerLilacCDNMetricsTag"
},
"x-displayname": "Group By",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace scope of the metric request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Format: unix_timestamp|RFC 3339.",
"title": "Start Time",
"x-displayname": "Start Time.",
"x-ves-example": "1659758607.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1659758607",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in\nthe response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step,\nwhere tn <= end_time. Depending on the time range, the step has a minimum value (due to rollups).\nFor e.g. For ranges in last one hr, step minimum is 5m, for ranges beyond a day, its 1h etc.\nStep value used is the max(<min-step-for-range>, <step-value-in-request>)\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "1m",
"x-f5xc-example": "1m",
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_loadbalancerLilacCDNMetricsRequest",
"required_fields": [
"end_time",
"field_selector",
"namespace",
"start_time"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_loadbalancerLilacCDNMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  end_time: value\n  field_selector: value\n  namespace: value\n  start_time: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"end_time\": \"value\",\n    \"field_selector\": \"value\",\n    \"namespace\": \"value\",\n    \"start_time\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"end_time": "value",
"field_selector": "value",
"namespace": "value",
"start_time": "value"
}
},
"requiredFields": [
"end_time",
"field_selector",
"namespace",
"start_time"
],
"description": "Minimum configuration for cdn_loadbalancerLilacCDNMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "Format: unix_timestamp|RFC 3339.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Fields (Metrics) selected to be queried.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 10,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "array",
"description": "CDN Metrics filter OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more tags.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace scope of the metric request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Format: unix_timestamp|RFC 3339.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in\nthe response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step,\nwhere tn <= end_time. Depending on the time range, the step has a minimum value (due to rollups).\nFor e.g. For ranges in last one hr, step minimum is 5m, for ranges beyond a day, its 1h etc.\nStep value used is the max(<min-step-for-range>, <step-value-in-request>)\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "CDN Metrics response data items. Each instance has response for a field queried."
},
{
"field": "step",
"type": "string",
"description": "The effective step used in the response. It could be higher than the requested step due to rollups.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"cdn-purge-commands": {
"name": "cdn-purge-commands",
"displayName": "Cdn Purge Commands",
"operations": [
{
"name": "create_cdn_purge_command",
"description": "Create CDN Cache Purge Command.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_purge_commands",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cdn_purge_command",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cdn_purge_command.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/schemacdn_purge_commandCreateSpecType"
}
],
"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 cdn_purge_commandCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_purge_commandCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cdn_purge_commandCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the CDN Purge Command specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hard_purge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hostname": {
"type": "string",
"description": "Exclusive with [pattern purge_all url_path]\nPurge cached content by Hostname.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "fqdn",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pattern": {
"type": "string",
"description": "Exclusive with [hostname purge_all url_path]\nPurge cached content using PCRE 1 compliant regular expression.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.purge_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.soft_purge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.url_path": {
"type": "string",
"description": "Exclusive with [hostname pattern purge_all]\nPurge cache by using a URL path.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_host": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_host.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.virtual_host.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_host.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.pattern_type": [
"hostname",
"pattern",
"purge_all",
"url_path"
],
"spec.purge_type": [
"hard_purge",
"soft_purge"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "list_cdn_purge_commands",
"description": "List CDN cache purge command.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_purge_commands",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cdn_purge_command",
"description": "DELETE CDN cache purge command.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cdn_purge_commands/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cdn_purge_command",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cdn_purge_command.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cdn_purge_commandDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cdn_purge_commandDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
}
},
{
"name": "get_cdn_purge_command",
"description": "GET CDN Cache Purge Command.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_purge_commands/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"certificate-chains": {
"name": "certificate-chains",
"displayName": "Certificate Chains",
"operations": [
{
"name": "create_certificate_chain",
"description": "Create Certificate Chain.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/certificate_chains",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"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": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/certificate_chainCreateSpecType"
}
],
"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"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-cert",
"namespace": "default"
},
"spec": {
"certificate_url": "string:///{{CERT_B64}}",
"private_key": {
      "clear_secret_info": {
      "url": "string:///{{KEY_B64}}",
      "provider": ""
}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.certificate_url",
"spec.private_key"
      ],
"description": "TLS certificate for securing HTTPS endpoints and connections"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Certificate Chain specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.certificate_url": {
"type": "string",
"description": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 131072,
"byteLength": {
"max": 131072,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_certificate_chain",
"description": "Replace Certificate Chain.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/certificate_chains/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/certificate_chainReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"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": [
"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"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-cert",
"namespace": "default"
},
"spec": {
"certificate_url": "string:///{{CERT_B64}}",
"private_key": {
      "clear_secret_info": {
      "url": "string:///{{KEY_B64}}",
      "provider": ""
}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.certificate_url",
"spec.private_key"
      ],
"description": "TLS certificate for securing HTTPS endpoints and connections"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Certificate Chain specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_certificate_chains",
"description": "List Certificate Chain.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/certificate_chains",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_certificate_chain",
"description": "DELETE Certificate Chain.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/certificate_chains/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for certificate_chainDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for certificate_chainDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
}
},
{
"name": "get_certificate_chain",
"description": "GET Certificate Chain.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/certificate_chains/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"certificates": {
"name": "certificates",
"displayName": "Certificates",
"operations": [
{
"name": "create_certificate",
"description": "Create Certificate.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/certificates",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"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"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-cert",
"namespace": "default"
},
"spec": {
"certificate_url": "string:///{{CERT_B64}}",
"private_key": {
      "clear_secret_info": {
      "url": "string:///{{KEY_B64}}",
      "provider": ""
}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.certificate_url",
"spec.private_key"
      ],
"description": "TLS certificate for securing HTTPS endpoints and connections"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Certificate specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.certificate_chain": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.certificate_chain.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.certificate_chain.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.certificate_chain.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.certificate_url": {
"type": "string",
"description": "Certificate.\nCertificate or certificate chain in PEM format including the PEM headers.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 131072,
"byteLength": {
"max": 131072,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_hash_algorithms": {
"type": "object",
"description": "Specifies the hash algorithms to be used.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_hash_algorithms.hash_algorithms": {
"type": "array",
"description": "Ordered list of hash algorithms to be used.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_ocsp_stapling": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_key.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_key.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_system_defaults": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ocsp_stapling_choice": [
"custom_hash_algorithms",
"disable_ocsp_stapling",
"use_system_defaults"
],
"spec.private_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_certificate",
"description": "Replace Certificate.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/certificates/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/certificateReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"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": [
"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"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-cert",
"namespace": "default"
},
"spec": {
"certificate_url": "string:///{{CERT_B64}}",
"private_key": {
      "clear_secret_info": {
      "url": "string:///{{KEY_B64}}",
      "provider": ""
}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.certificate_url",
"spec.private_key"
      ],
"description": "TLS certificate for securing HTTPS endpoints and connections"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Certificate specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.certificate_chain": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.certificate_chain.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.certificate_chain.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.certificate_chain.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.certificate_url": {
"type": "string",
"description": "Certificate.\nCertificate or certificate chain in PEM format including the PEM headers.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 131072,
"byteLength": {
"max": 131072,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_hash_algorithms": {
"type": "object",
"description": "Specifies the hash algorithms to be used.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_hash_algorithms.hash_algorithms": {
"type": "array",
"description": "Ordered list of hash algorithms to be used.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_ocsp_stapling": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_key.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_key.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_system_defaults": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ocsp_stapling_choice": [
"custom_hash_algorithms",
"disable_ocsp_stapling",
"use_system_defaults"
],
"spec.private_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_certificates",
"description": "List Certificate.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/certificates",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_certificate",
"description": "DELETE Certificate.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/certificates/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for certificateDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for certificateDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
}
},
{
"name": "get_certificate",
"description": "GET Certificate.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/certificates/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"certified-hardwares": {
"name": "certified-hardwares",
"displayName": "Certified Hardwares",
"operations": [
{
"name": "list_certified_hardwares",
"description": "List Certified Hardware.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/certified_hardwares",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_certified_hardware",
"description": "GET Certified Hardware.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/certified_hardwares/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"child-tenant-managers": {
"name": "child-tenant-managers",
"displayName": "Child Tenant Managers",
"operations": [
{
"name": "create_child_tenant_manager",
"description": "Child Tenant Manager.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/child_tenant_managers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of child_tenant_manager",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.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/tenant_managementchild_tenant_managerCreateSpecType"
}
],
"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 tenant_managementchild_tenant_managerCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementchild_tenant_managerCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementchild_tenant_managerCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a child_tenant_manager config instance. Name of the object is the name of the child tenant manager to be created.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.group_assignments": {
"type": "array",
"description": "The Group Mapping field is used to associate local user groups with user groups in child tenants.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_owner_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_owner_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tenant_owner_group.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_owner_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.tenant_owner_choice": [
"tenant_owner_group"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_child_tenant_manager",
"description": "Replace Child Tenant Manager.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/child_tenant_managers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a child_tenant_manager",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.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/tenant_managementchild_tenant_managerReplaceSpecType"
}
],
"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 child_tenant_managerReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for child_tenant_managerReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for child_tenant_managerReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a child_tenant_manager configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.banner_message": {
"type": "object",
"description": "CTBannerNotification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.banner_message.content_html": {
"type": "string",
"description": "Exclusive with [content_text]\nHTML content of the specific notification.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.banner_message.content_text": {
"type": "string",
"description": "Exclusive with [content_html]\nText content of the specific notification.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.banner_message.time_period": {
"type": "object",
"description": "Date range is for selecting a date range.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.banner_message.title": {
"type": "string",
"description": "Title of the specific notification in plain text.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.group_assignments": {
"type": "array",
"description": "The Group Mapping field is used to associate local user groups with user groups in child tenants.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_owner_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_owner_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tenant_owner_group.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_owner_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.tenant_owner_choice": [
"tenant_owner_group"
],
"spec.banner_message.content_choice": [
"content_html",
"content_text"
]
}
},
{
"name": "list_child_tenant_managers",
"description": "List Child Tenant Manager.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/child_tenant_managers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_child_tenant_manager",
"description": "DELETE Child Tenant Manager.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/child_tenant_managers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a child_tenant_manager",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for child_tenant_managerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for child_tenant_managerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_child_tenant_manager",
"description": "GET Child Tenant Manager.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/child_tenant_managers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"child-tenant-support-tickets": {
"name": "child-tenant-support-tickets",
"displayName": "Child Tenant Support Tickets",
"operations": [
{
"name": "create_child_tenant_support_ticket",
"description": "List of support tickets created for a child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/child_tenant/support_tickets",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'ListCTSupportTickets' RPC. Fields can be used to control\nscope and filtering of collection.",
"title": "ListSupportRequest",
"x-displayname": "List Support Request.",
"x-ves-proto-message": "ves.io.schema.customer_support.ListSupportRequest",
"properties": {
"priority": {
"type": "array",
"description": "List of priorities for filtering the customer support ticket list.",
"title": "priority",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/customer_supportSupportTicketPriority"
},
"x-displayname": "Priority",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.items.enum.not_in": "0",
"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.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.items.enum.not_in": "0",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "10",
"x-f5xc-description-short": "List of priorities for filtering the customer support ticket list.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"status": {
"type": "array",
"description": "List of status for filtering the customer support ticket list.",
"title": "status",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/customer_supportSupportTicketStatus"
},
"x-displayname": "Status",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.items.enum.not_in": "0",
"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.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.items.enum.not_in": "0",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "active",
"x-f5xc-description-short": "List of status for filtering the customer support ticket list.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Input message of the 'ListCTSupportTickets' RPC. Fields can be used to control scope and filtering of collection.",
"x-f5xc-description-medium": "Input message of the 'ListCTSupportTickets' RPC. Fields can be used to control scope and filtering of collection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportListSupportRequest",
"required_fields": [
"priority",
"status"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportListSupportRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  priority: value\n  status: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"priority\": \"value\",\n    \"status\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"priority": "value",
"status": "value"
}
},
"requiredFields": [
"priority",
"status"
],
"description": "Minimum configuration for customer_supportListSupportRequest"
},
"fieldMetadata": {
"priority": {
"type": "array",
"description": "List of priorities for filtering the customer support ticket list.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"status": {
"type": "array",
"description": "List of status for filtering the customer support ticket list.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
}
]
},
	"child-tenants": {
"name": "child-tenants",
"displayName": "Child Tenants",
"operations": [
{
"name": "create_child_tenant",
"description": "Child Tenant.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/child_tenants",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of child_tenant",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.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/tenant_managementchild_tenantCreateSpecType"
}
],
"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 tenant_managementchild_tenantCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementchild_tenantCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementchild_tenantCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.child_tenant_manager": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.child_tenant_manager.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.child_tenant_manager.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.child_tenant_manager.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.company_name": {
"type": "string",
"description": "Company name (enterprise only)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"spec.contact_detail.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info": {
"type": "object",
"description": "Optional details for the new child tenant.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.additional_info": {
"type": "string",
"description": "Use this field for any additional information about the new child tenant.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.email": {
"type": "string",
"description": "Email address in RFC 5322 format",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.first_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.last_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain": {
"type": "string",
"description": "Text string that will be used for the subdomain of the new Child Tenant.\nThis will be where users will directly log into the new Child Tenant. Example domain.console.ves.volterra.I/O.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 5,
"maxLength": 17,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tenant_profile": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_profile.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tenant_profile.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_profile.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_child_tenant",
"description": "Replace Child Tenant.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/child_tenants/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a child_tenant",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.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/tenant_managementchild_tenantReplaceSpecType"
}
],
"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 child_tenantReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for child_tenantReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for child_tenantReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a child_tenant configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.company_name": {
"type": "string",
"description": "Company name (enterprise only)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"spec.contact_detail.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_detail.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info": {
"type": "object",
"description": "Optional details for the new child tenant.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.additional_info": {
"type": "string",
"description": "Use this field for any additional information about the new child tenant.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.email": {
"type": "string",
"description": "Email address in RFC 5322 format",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.first_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.customer_info.last_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_child_tenants",
"description": "List Child Tenant.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/child_tenants",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_child_tenant",
"description": "DELETE Child Tenant.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/child_tenants/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a child_tenant",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for child_tenantDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for child_tenantDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_child_tenant",
"description": "GET Child Tenant.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/child_tenants/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"close": {
"name": "close",
"displayName": "Close",
"operations": [
{
"name": "create_close",
"description": "Close a customer support ticket.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/customer_support/{name}/close",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Closes an open existing customer support ticket.",
"title": "Close comment request",
"x-displayname": "Customer support ticket close request.",
"x-ves-proto-message": "ves.io.schema.customer_support.CloseRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be closed.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the customer support ticket object to be closed.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Closes an open existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportCloseRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportCloseRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportCloseRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be closed.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"cloud-connects": {
"name": "cloud-connects",
"displayName": "Cloud Connects",
"operations": [
{
"name": "create_cloud_connect",
"description": "Create Cloud Connect.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cloud_connects",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cloud_connect",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemacloud_connectCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Cloud Connect specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_provider": {
"type": "object",
"description": "Cloud Connect with AWS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_provider.aws_tgw_site": {
"type": "object",
"description": "Cloud Connect AWS TGW Site Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_vnet_site": {
"type": "object",
"description": "Cloud Connect Azure VNet Site Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_vnet_site.site": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_vnet_site.vnet_attachments": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.segment.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cloud": [
"aws_provider",
"azure_vnet_site"
],
"spec.aws_provider.site_type": [
"aws_tgw_site"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cloud_connect",
"description": "Replace Cloud Connect.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cloud_connects/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cloud_connect",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemacloud_connectReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Cloud Connect specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_provider": {
"type": "object",
"description": "Cloud Connect with AWS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_provider.aws_tgw_site": {
"type": "object",
"description": "Cloud Connect AWS TGW Site Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_vnet_site": {
"type": "object",
"description": "Cloud Connect Azure VNet Site Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_vnet_site.vnet_attachments": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cloud": [
"aws_provider",
"azure_vnet_site"
],
"spec.aws_provider.site_type": [
"aws_tgw_site"
]
}
},
{
"name": "list_cloud_connects",
"description": "List Cloud Connect.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_connects",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cloud_connect",
"description": "DELETE Cloud Connect.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cloud_connects/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cloud_connect",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
}
},
{
"name": "get_cloud_connect",
"description": "GET Cloud Connect.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_connects/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cloud-connects-metrics": {
"name": "cloud-connects-metrics",
"displayName": "Cloud Connects Metrics",
"operations": [
{
"name": "create_cloud_connects_metric",
"description": "All Cloud Connect Metrics.",
"method": "POST",
"path": "/api/data/namespaces/system/cloud_connects/metrics",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Cloud_connect API is used to GET the in/out throughput\nfor the tenant's customer edges.",
      "title": "List metrics Request",
"x-displayname": "List Metrics Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.ListMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to fetch cloud connect data.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to fetch cloud connect data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.",
"title": "field_selector",
"items": {
"$ref": "#/components/schemas/cloud_connectFieldSelector"
},
"x-displayname": "Field Selector.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. Field_selector is used to specify the fields to be returned in the response, thereby limiting the amount of data returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, cloud connect data for all sites will be returned in the response.",
      "title": "label_filter",
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/cloud_connectLabelFilter"
},
"x-displayname": "Label Filter.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, cloud connect data for all sites will be returned in the response.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to fetch cloud connect data.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to fetch cloud connect data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Cloud_connect API is used to GET the in/out throughput for the tenant's customer edges.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectListMetricsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectListMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {
"cloud_connect": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectListMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, cloud connect data for all sites will be returned in the response.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "cloud_connect",
"type": "array",
"description": "Metric data specified for the cloud connect."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"cloud-connects-segment-metrics": {
"name": "cloud-connects-segment-metrics",
"displayName": "Cloud Connects Segment Metrics",
"operations": [
{
"name": "create_cloud_connects_segment_metric",
"description": "All Cloud Connect Segment Metrics.",
"method": "POST",
"path": "/api/data/namespaces/system/cloud_connects/segment_metrics",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Cloud_connect API is used to GET the in/out throughput\nfor the tenant's customer edges.",
      "title": "List Segment metrics Request",
"x-displayname": "List Metrics Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.ListSegmentMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to fetch cloud connect data.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to fetch cloud connect data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.",
"title": "field_selector",
"items": {
"$ref": "#/components/schemas/cloud_connectFieldSelector"
},
"x-displayname": "Field Selector.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. Field_selector is used to specify the fields to be returned in the response, thereby limiting the amount of data returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"format": "boolean",
"x-displayname": "Trend calculation requested by the user.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, cloud connect data for all sites will be returned in the response.",
      "title": "label_filter",
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/cloud_connectLabelFilter"
},
"x-displayname": "Label Filter.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, cloud connect data for all sites will be returned in the response.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to fetch cloud connect data.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to fetch cloud connect data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Cloud_connect API is used to GET the in/out throughput for the tenant's customer edges.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectListSegmentMetricsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectListSegmentMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"segment": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectListSegmentMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, cloud connect data for all sites will be returned in the response.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "Cloud connect data for list of customer edges owned by a tenant."
},
{
"field": "segment",
"type": "array",
"description": "Metric data for the given metric."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"cloud-credentialss": {
"name": "cloud-credentialss",
      "displayName": "Cloud Credentialss",
      "operations": [
{
"name": "create_cloud_credential",
      "description": "Create Cloud Credentials.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/cloud_credentialss",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cloud_credentials",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cloud_credentials.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/cloud_credentialsCreateSpecType"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_credentialsCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_credentialsCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_credentialsCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to create cloud_credentials object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role": {
"type": "object",
"description": "AWS Assume Role to Handle Delegated Access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.custom_external_id": {
"type": "string",
"description": "Exclusive with [external_id_is_optional external_id_is_tenant_id]\nExternal ID is Custom ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 2,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.duration_seconds": {
"type": "integer",
"description": "The duration, in seconds of the role session.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 3600,
"maximum": 43200,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_assume_role.external_id_is_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.external_id_is_tenant_id": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.role_arn": {
"type": "string",
"description": "IAM Role ARN to assume the role.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 20,
"maxLength": 2048,
"pattern": "^(arn:aws:iam::)([0-9]{12}:role/.*)$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_assume_role.session_name": {
"type": "string",
"description": "Use the role session name to uniquely identify a session, which will\nbe used for deploy, monitor from F5XC console.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 2,
"maxLength": 64,
"pattern": "[\\\\w+=,.@-]*",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_assume_role.session_tags": {
"type": "object",
"description": "Session tags are key-value pair attributes that you pass when you assume an IAM role.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_secret_key": {
      "type": "object",
"description": "AWS Programmatic Access Credentials type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_secret_key.access_key": {
      "type": "string",
"description": "Access key ID for your AWS account.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_secret_key.secret_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_client_secret": {
      "type": "object",
"description": "Azure Credentials Client Secret type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_client_secret.client_id": {
      "type": "string",
"description": "Client ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_client_secret.client_secret": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_client_secret.subscription_id": {
      "type": "string",
"description": "Subscription ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_client_secret.tenant_id": {
      "type": "string",
"description": "Tenant ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate": {
"type": "object",
"description": "Azure Credentials Client Certificate type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.certificate_url": {
"type": "string",
"description": "URL for Client Certificate in '.pfx' or '.p12' whose certificate is linked to service principal object\nCertificate URL can contain client certificate in string:///<Base64 of certificate> format.\nHere <Base64 of certificate> is base64 of '.pfx' or '.p12' binary file.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8192,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.client_id": {
"type": "string",
"description": "Client ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.subscription_id": {
"type": "string",
"description": "Subscription ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.tenant_id": {
"type": "string",
"description": "Tenant ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_cred_file": {
"type": "object",
"description": "GCP Credentials type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_cred_file.credential_file": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cloud": [
"aws_assume_role",
"aws_secret_key",
      "azure_client_secret",
      "azure_pfx_certificate",
"gcp_cred_file"
],
"spec.aws_assume_role.external_id": [
"custom_external_id",
"external_id_is_optional",
"external_id_is_tenant_id"
],
"spec.aws_secret_key.secret_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_client_secret.client_secret.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_pfx_certificate.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.gcp_cred_file.credential_file.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cloud_credential",
      "description": "Replace Cloud Credentials.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/cloud_credentialss/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cloud_credentials",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cloud_credentials.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/cloud_credentialsReplaceSpecType"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_credentialsReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_credentialsReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_credentialsReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to replace cloud_credentials object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role": {
"type": "object",
"description": "AWS Assume Role to Handle Delegated Access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.custom_external_id": {
"type": "string",
"description": "Exclusive with [external_id_is_optional external_id_is_tenant_id]\nExternal ID is Custom ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 2,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.duration_seconds": {
"type": "integer",
"description": "The duration, in seconds of the role session.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 3600,
"maximum": 43200,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_assume_role.external_id_is_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.external_id_is_tenant_id": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_assume_role.role_arn": {
"type": "string",
"description": "IAM Role ARN to assume the role.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 20,
"maxLength": 2048,
"pattern": "^(arn:aws:iam::)([0-9]{12}:role/.*)$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_assume_role.session_name": {
"type": "string",
"description": "Use the role session name to uniquely identify a session, which will\nbe used for deploy, monitor from F5XC console.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 2,
"maxLength": 64,
"pattern": "[\\\\w+=,.@-]*",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_assume_role.session_tags": {
"type": "object",
"description": "Session tags are key-value pair attributes that you pass when you assume an IAM role.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_secret_key": {
      "type": "object",
"description": "AWS Programmatic Access Credentials type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_secret_key.access_key": {
      "type": "string",
"description": "Access key ID for your AWS account.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_secret_key.secret_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_client_secret": {
      "type": "object",
"description": "Azure Credentials Client Secret type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_client_secret.client_id": {
      "type": "string",
"description": "Client ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_client_secret.client_secret": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_client_secret.subscription_id": {
      "type": "string",
"description": "Subscription ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_client_secret.tenant_id": {
      "type": "string",
"description": "Tenant ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate": {
"type": "object",
"description": "Azure Credentials Client Certificate type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.certificate_url": {
"type": "string",
"description": "URL for Client Certificate in '.pfx' or '.p12' whose certificate is linked to service principal object\nCertificate URL can contain client certificate in string:///<Base64 of certificate> format.\nHere <Base64 of certificate> is base64 of '.pfx' or '.p12' binary file.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8192,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.client_id": {
"type": "string",
"description": "Client ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.subscription_id": {
"type": "string",
"description": "Subscription ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_pfx_certificate.tenant_id": {
"type": "string",
"description": "Tenant ID for your Azure service principal.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_cred_file": {
"type": "object",
"description": "GCP Credentials type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_cred_file.credential_file": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cloud": [
"aws_assume_role",
"aws_secret_key",
      "azure_client_secret",
      "azure_pfx_certificate",
"gcp_cred_file"
],
"spec.aws_assume_role.external_id": [
"custom_external_id",
"external_id_is_optional",
"external_id_is_tenant_id"
],
"spec.aws_secret_key.secret_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_client_secret.client_secret.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_pfx_certificate.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.gcp_cred_file.credential_file.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_cloud_credentialss",
      "description": "List Cloud Credentials.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_credentialss",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cloud_credential",
      "description": "DELETE Cloud Credentials.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cloud_credentialss/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cloud_credentials",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cloud_credentials.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_credentialsDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_credentialsDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
}
},
{
"name": "get_cloud_credential",
      "description": "GET Cloud Credentials.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_credentialss/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cloud-data-cloud-user-accounts-onboarded-networks": {
"name": "cloud-data-cloud-user-accounts-onboarded-networks",
"displayName": "Cloud Data Cloud User Accounts Onboarded Networks",
"operations": [
{
"name": "list_cloud_data_cloud_user_accounts_onboarded_networks",
"description": "GET Onboarded Cloud Networks.",
"method": "GET",
"path": "/api/cloud-data/namespaces/system/cloud_user_accounts/{cloud_user_account_name}/onboarded_networks",
      "dangerLevel": "low",
"parameters": [
{
"name": "cloud_user_account_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"onboarded_network": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "onboarded_network",
"type": "array",
"description": "Onboarded networks."
}
]
}
]
},
	"cloud-data-cloud-user-accounts-validate": {
"name": "cloud-data-cloud-user-accounts-validate",
"displayName": "Cloud Data Cloud User Accounts Validate",
"operations": [
{
"name": "list_cloud_data_cloud_user_accounts_validate",
"description": "Validates Cloud User Account.",
"method": "GET",
"path": "/api/cloud-data/namespaces/system/cloud_user_accounts/{cloud_user_account_name}/validate",
      "dangerLevel": "low",
"parameters": [
{
"name": "cloud_user_account_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"is_valid": {
"type": "boolean"
},
"validated_at": {
"type": "string"
},
"validation_errors": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "is_valid",
"type": "boolean",
"description": "Indicates whether the cloud user account is valid."
},
{
"field": "validated_at",
"type": "string",
"description": "Timestamp when the validation was performed."
},
{
"field": "validation_errors",
"type": "array",
"description": "List of validation errors encountered during validation."
}
]
}
]
},
	"cloud-data-suggest-values": {
"name": "cloud-data-suggest-values",
"displayName": "Cloud Data Suggest Values",
"operations": [
{
"name": "create_cloud_data_suggest_value",
"description": "Suggest Values.",
"method": "POST",
"path": "/api/cloud-data/namespaces/system/suggest-values",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of SuggestValues request.",
"title": "SuggestValuesReq",
"x-displayname": "Request for SuggestValues.",
"x-ves-proto-message": "ves.io.schema.namespace.SuggestValuesReq",
"properties": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"title": "field_path",
"maxLength": 1024,
"x-displayname": "Field Path.",
"x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match",
      "x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"title": "match_value",
"maxLength": 256,
"x-displayname": "Match Value.",
"x-ves-example": "Some-substring.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "some-substring",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"request_body": {
"allOf": [
{
"$ref": "#/components/schemas/protobufAny"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceSuggestValuesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceSuggestValuesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceSuggestValuesReq"
},
"fieldMetadata": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body": {
"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\": <string>,\n\"lastName\": <string>\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}",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.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.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.value": {
"type": "string",
"description": "Must be a valid serialized protocol buffer of the above specified type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of suggested items."
}
]
}
]
},
	"cloud-elastic-ip-force-delete": {
"name": "cloud-elastic-ip-force-delete",
"displayName": "Cloud Elastic Ip Force Delete",
"operations": [
{
"name": "create_cloud_elastic_ip_force_delete",
"description": "Force DELETE Cloud Elastic IP.",
"method": "POST",
"path": "/api/config/namespaces/system/cloud_elastic_ip/{name}/force-delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Force DELETE Cloud Elastic IP Request.",
"title": "ForceDeleteCloudElasticIPRequest",
"x-displayname": "Force DELETE Cloud Elastic IP Request.",
"x-ves-proto-message": "ves.io.schema.cloud_elastic_ip.ForceDeleteCloudElasticIPRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the Cloud Elastic IP object to be force deleted.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Cloud-elastic-IP-1.",
"x-f5xc-example": "cloud-elastic-ip-1",
"x-f5xc-description-short": "Name of the Cloud Elastic IP object to be force deleted.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_elastic_ipForceDeleteCloudElasticIPRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_elastic_ipForceDeleteCloudElasticIPRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_elastic_ipForceDeleteCloudElasticIPRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the Cloud Elastic IP object to be force deleted.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"cloud-elastic-ips": {
"name": "cloud-elastic-ips",
"displayName": "Cloud Elastic Ips",
"operations": [
{
"name": "create_cloud_elastic_ip",
"description": "Create Cloud Elastic IP.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cloud_elastic_ips",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cloud_elastic_ip",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cloud_elastic_ip.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/cloud_elastic_ipCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_elastic_ipCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_elastic_ipCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_elastic_ipCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Cloud Elastic IP creates Cloud Elastic IP object\nObject is attached to a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.count": {
"type": "integer",
"description": "Number of Elastic Ips / Public Ips associated with this object per Node.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 8,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.site_ref": {
"type": "array",
"description": "Site to which this cloud elastic IP object is attached.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cloud_elastic_ip",
"description": "Replace Cloud Elastic IP.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cloud_elastic_ips/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cloud_elastic_ip",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cloud_elastic_ip.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/cloud_elastic_ipReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_elastic_ipReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_elastic_ipReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_elastic_ipReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace cloud elastic IP will replace cloud elastic IP object with new object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.count": {
"type": "integer",
"description": "Number of Elastic Ips / Public Ips associated with this object per Node.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 8,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.site_ref": {
"type": "array",
"description": "Site to which this cloud elastic IP object is attached.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_cloud_elastic_ips",
"description": "List Cloud Elastic IP.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_elastic_ips",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cloud_elastic_ip",
"description": "DELETE Cloud Elastic IP.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cloud_elastic_ips/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cloud_elastic_ip",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cloud_elastic_ip.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_elastic_ipDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_elastic_ipDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
}
},
{
"name": "get_cloud_elastic_ip",
"description": "GET Cloud Elastic IP.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_elastic_ips/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cloud-links": {
"name": "cloud-links",
"displayName": "Cloud Links",
"operations": [
{
"name": "create_cloud_link",
"description": "Create CloudLink.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cloud_links",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cloud_link",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cloud_link.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemacloud_linkCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_linkCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_linkCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_linkCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new CloudLink with configured parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws": {
"type": "object",
"description": "CloudLink for AWS Cloud Provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.byoc": {
"type": "object",
"description": "List of Bring You Own Connection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.custom_asn": {
"type": "integer",
"description": "Exclusive with []\nF5XC will use custom ASN to create a Direct Connect Gateway.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 4294967294,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled.cloudlink_network_name": {
"type": "string",
"description": "Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp": {
"type": "object",
"description": "CloudLink for GCP Cloud Provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp.byoc": {
"type": "object",
"description": "List of GCP Bring You Own Connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp.gcp_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cloud_provider": [
"aws",
"gcp"
],
"spec.enable_connection_to_re_choice": [
"disabled",
"enabled"
],
"spec.aws.cloud_link_type": [
"byoc"
],
"spec.aws.direct_connect_gateway_asn_choice": [
"custom_asn"
],
"spec.gcp.cloud_link_type": [
"byoc"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cloud_link",
"description": "Replace CloudLink.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cloud_links/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cloud_link",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cloud_link.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemacloud_linkReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_linkReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_linkReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_linkReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces configured CloudLink with new set of parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws": {
"type": "object",
"description": "CloudLink for AWS Cloud Provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.byoc": {
"type": "object",
"description": "List of Bring You Own Connection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.custom_asn": {
"type": "integer",
"description": "Exclusive with []\nF5XC will use custom ASN to create a Direct Connect Gateway.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 4294967294,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled.cloudlink_network_name": {
"type": "string",
"description": "Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp": {
"type": "object",
"description": "CloudLink for GCP Cloud Provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp.byoc": {
"type": "object",
"description": "List of GCP Bring You Own Connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp.gcp_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cloud_provider": [
"aws",
"gcp"
],
"spec.enable_connection_to_re_choice": [
"disabled",
"enabled"
],
"spec.aws.cloud_link_type": [
"byoc"
],
"spec.aws.direct_connect_gateway_asn_choice": [
"custom_asn"
],
"spec.gcp.cloud_link_type": [
"byoc"
]
}
},
{
"name": "list_cloud_links",
"description": "List CloudLink.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_links",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cloud_link",
"description": "DELETE CloudLink.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cloud_links/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cloud_link",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cloud_link.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_linkDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_linkDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
}
},
{
"name": "get_cloud_link",
"description": "GET CloudLink.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_links/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cloud-links-reapply-config": {
"name": "cloud-links-reapply-config",
"displayName": "Cloud Links Reapply Config",
"operations": [
{
"name": "create_cloud_links_reapply_config",
"description": "CloudLink",
"method": "POST",
"path": "/api/config/namespaces/system/cloud_links/{name}/reapply_config",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Reapply CloudLink Config.",
"title": "CloudLink Reapply Config Request",
"x-displayname": "CloudLink Reapply Config Request.",
"x-ves-proto-message": "ves.io.schema.cloud_link.ReapplyConfigRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of Cloud Link.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-cloud-link-east.",
"x-f5xc-example": "aws-cloud-link-east",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_linkReapplyConfigRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_linkReapplyConfigRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_linkReapplyConfigRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of Cloud Link.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"cloud-regions": {
"name": "cloud-regions",
"displayName": "Cloud Regions",
"operations": [
{
"name": "replace_cloud_region",
"description": "Replace Cloud Region.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cloud_regions/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cloud_region",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cloud_region.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/cloud_regionReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_regionReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_regionReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_regionReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the cloud RE specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_policy_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policy_group.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.policy_group_choice": [
"default_policy_group",
"policy_group"
]
}
},
{
"name": "list_cloud_regions",
"description": "List Cloud Region.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_regions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_cloud_region",
"description": "GET Cloud Region.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cloud_regions/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"clusters": {
"name": "clusters",
"displayName": "Clusters",
"operations": [
{
"name": "create_cluster",
"description": "Create Cluster.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/clusters",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cluster",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cluster.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/clusterCreateSpecType"
}
],
"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 clusterCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for clusterCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for clusterCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create cluster will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.auto_http_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker": {
"type": "object",
"description": "CircuitBreaker provides a mechanism for watching failures in upstream connections or requests\nand if the failures reach a certain threshold, automatically fail subsequent requests which\nallows to apply back pressure on downstream quickly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.connection_limit": {
"type": "integer",
"description": "The maximum number of connections that loadbalancer will establish to all hosts in an upstream cluster.\nIn practice this is only applicable to TCP and HTTP/1.1 clusters since HTTP/2 uses a single connection to each host.\nRemove endpoint out of load balancing decision, if number of connections reach connection limit.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.max_requests": {
"type": "integer",
"description": "The maximum number of requests that can be outstanding to all hosts in a cluster at any given time.\nIn practice this is applicable to HTTP/2 clusters since HTTP/1.1 clusters are governed by the\nmaximum connections (connection_limit).\nRemove endpoint out of load balancing decision, if requests exceed this count.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.pending_requests": {
"type": "integer",
"description": "The maximum number of requests that will be queued while waiting for a ready connection pool connection.\nSince HTTP/2 requests are sent over a single connection, this circuit breaker only comes into play as the\ninitial connection is created, as requests will be multiplexed immediately afterwards. For HTTP/1.1, requests\nare added to the list of pending requests whenever there aren’t enough upstream connections available to\nimmediately dispatch the request, so this circuit breaker will remain in play for the lifetime of the process.\nRemove endpoint out of load balancing decision, if pending request reach pending_request.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.priority": {
"type": "string",
"description": "Priority routing for each request.\nDifferent connection pools are used based on the priority selected for the request.\nAlso, circuit-breaker configuration at destination cluster is chosen based on selected priority.\n\nDefault routing mechanism\nHigh-Priority routing mechanism.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DEFAULT"
},
"spec.circuit_breaker.retries": {
"type": "integer",
"description": "The maximum number of retries that can be outstanding to all hosts in a cluster at any given time.\nRemove endpoint out of load balancing decision, if retries for request exceed this count.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 32768,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to endpoints in the cluster.\nThis is specified in milliseconds. The default value is 2 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_subset": {
"type": "object",
"description": "List of key-value pairs that define default subset. This subset can be referred in fallback_policy\nwhich gets used when route specifies no metadata or no subset matching the metadata exists.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_proxy_protocol": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint_selection": {
"type": "string",
"description": "Policy for selection of endpoints from local site/remote site/both\n\nConsider both remote and local endpoints for load balancing\nLOCAL_ONLY: Consider only local endpoints for load balancing\nEnable this policy to load balance ONLY among locally discovered endpoints\nPrefer the local endpoints for load balancing. If local endpoints are not present\nremote endpoints will be considered.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISTRIBUTED"
},
"spec.endpoint_subsets": {
"type": "array",
"description": "Cluster may be configured to divide its endpoints into subsets based on metadata\nattached to the endpoints. Routes may then specify the metadata that a endpoint must match in\norder to be selected by the load balancer.\n\nEndpoint_subsets is list of subsets for this cluster. Each entry in this list has definition for a subset\n(which is collection of keys)\n\nDuring routing, the route’s metadata match configuration is used to find a specific subset.\nIf there is a subset with the exact keys and values specified by the route, the subset is used\nfor load balancing. Otherwise, the fallback policy is used. The cluster’s subset configuration must,\ntherefore, contain a definition that has the same keys as a given route in order for subset load\nbalancing to occur.\n\nExample:\n\nRouteConfig\n\nroutes:\n- match:\n - headers: []\npath:\npath: /1.log\nquery_params: []\nrouteDestination:\ndestinations:\n - cluster:\n - kind: cluster.object\nuid: 00000000-0000-4000-8000-0b50b89d07a2\nendpointSubsets:\nsite: india\n\nEndpointConfig\n\nmetadata:\nlabels:\ndeployment: debug\nsite: india\nname: end-1\nuid: end-1\n\nClusterConfig\n\ngcSpec:\ndefaultSubset:\nstage: production\nfallbackPolicy: DEFAULT_SUBSET\nendpointSubsets:\n - keys:\n - site\n - keys:\n - stage\n - app\n\nAssume the below endpoints are defined and associated with the cluster.\n\nEndpoint Labels\n-------- ------\n\nep1 stage: production, site: india\nep2 stage: deployment, site: us\nep3 stage: production, app: hr\nep4 site: india\n\nThe following table describes some routes and the result of their application\nto the cluster. The subset definition for cluster is assumed to be same as given\nabove in the ClusterConfig section\n\nRouteMatch Criteria Subset Reason\n------------------- ------ ------\n\nsite: india ep1, ep4 Subset of endpoints selected\nsite: us ep2 Subset of endpoints selected\napp: hr ep1, ep3 Fallback: No subset selector for \"app\" alone\nstage: production, app: hr ep3 Subset of endpoints selected\nother: x ep1, ep3 Fallback: No subset selector for “other”\n(none) ep1, ep3 Fallback: No subset requested.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoints": {
"type": "array",
"description": "List of references to all endpoint objects that belong to this cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.fallback_policy": {
"type": "string",
"description": "Enumeration for SubsetFallbackPolicy if subset match is not found.\n\nThe request fails as if the cluster had no endpoint matching the subset policy\nAny cluster endpoint may be selected if the cluster had no endpoint matching the subset policy\nLoad balancing is done over endpoints matching default_subset if the cluster had no\nendpoint matching the subset policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "NO_FALLBACK"
},
"spec.health_checks": {
"type": "array",
"description": "List of references to healthcheck object for this cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http1_config": {
"type": "object",
"description": "HTTP/1.1 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http1_config.header_transformation": {
"type": "object",
"description": "Header Transformation OPTIONS for HTTP/1.1 request/response headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http2_options": {
"type": "object",
"description": "Http2 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http2_options.enabled": {
"type": "boolean",
"description": "Enable/disable HTTP2 Protocol for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_idle_timeout": {
"type": "integer",
"description": "The idle timeout for upstream connection pool connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 5 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.loadbalancer_algorithm": {
"type": "string",
"description": "Different load balancing algorithms supported\nWhen a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm\nto determine which host is selected.\n\n- ROUND_ROBIN: ROUND_ROBIN\n\nPolicy in which each healthy/available upstream endpoint is selected in round robin order.\n- LEAST_REQUEST: LEAST_REQUEST\n\nPolicy in which loadbalancer picks the upstream endpoint which has the fewest active requests\n- RING_HASH: RING_HASH\n\nPolicy implements consistent hashing to upstream endpoints using ring hash of endpoint names\nHash of the incoming request is calculated using request hash policy.\nThe ring/modulo hash load balancer implements consistent hashing to upstream hosts.\nThe algorithm is based on mapping all hosts onto a circle such that the addition or\nremoval of a host from the host set changes only affect 1/N requests. This technique\nis also commonly known as “ketama” hashing. A consistent hashing load balancer is only\neffective when protocol routing is used that specifies a value to hash on. The minimum\nring size governs the replication factor for each host in the ring. For example, if the\nminimum ring size is 1024 and there are 16 hosts, each host will be replicated 64 times.\n- RANDOM: RANDOM\n\nPolicy in which each available upstream endpoint is selected in random order.\nThe random load balancer selects a random healthy host. The random load balancer generally\nperforms better than round robin if no health checking policy is configured. Random selection\navoids bias towards the host in the set that comes after a failed host.\n- LB_OVERRIDE: Load Balancer Override\n\nHash policy is taken from from the load balancer which is using this origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ROUND_ROBIN"
},
"spec.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\n\nSets the maximum number of requests allowed per connection to the origin server.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_panic_threshold": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection": {
"type": "object",
"description": "Outlier detection and ejection is the process of dynamically determining whether some number\nof hosts in an upstream cluster are performing unlike the others and removing them from the\nhealthy load balancing set. Outlier detection is a form of passive health checking.\n\nAlgorithm\n\n1. A endpoint is determined to be an outlier (based on configured number of consecutive_5xx\nor consecutive_gateway_failures) .\n2. If no endpoints have been ejected, loadbalancer will eject the host immediately.\nOtherwise, it checks to make sure the number of ejected hosts is below the allowed threshold\n(specified via max_ejection_percent setting). If the number of ejected hosts is above the\nthreshold, the host is not ejected.\n3. The endpoint is ejected for some number of milliseconds. Ejection means that the endpoint is marked\nunhealthy and will not be used during load balancing. The number of milliseconds is equal to the\nbase_ejection_time value multiplied by the number of times the host has been ejected.\n4. An ejected endpoint will automatically be brought back into service after the ejection time\nhas been satisfied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.base_ejection_time": {
"type": "integer",
"description": "The base time that a host is ejected for. The real time is equal to the\nbase time multiplied by the number of times the host has been ejected.\nThis causes hosts to GET ejected for longer periods if they continue to fail.\nDefaults to 30000ms or 30s. Specified in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.consecutive_5xx": {
"type": "integer",
"description": "If an upstream endpoint returns some number of consecutive 5xx, it will be ejected.\nNote that in this case a 5xx means an actual 5xx respond code, or an event that would\ncause the HTTP router to return one on the upstream’s behalf(reset, connection failure, etc.)\nconsecutive_5xx indicates the number of consecutive 5xx responses required before\na consecutive 5xx ejection occurs. Defaults to 5.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.consecutive_gateway_failure": {
"type": "integer",
"description": "If an upstream endpoint returns some number of consecutive “gateway errors”\n(502, 503 or 504 status code), it will be ejected. Note that this includes events\nthat would cause the HTTP router to return one of these status codes on the\nupstream’s behalf (reset, connection failure, etc.).\nConsecutive_gateway_failure indicates the number of consecutive gateway failures\nbefore a consecutive gateway failure ejection occurs. Defaults to 5.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.interval": {
"type": "integer",
"description": "The time interval between ejection analysis sweeps. This can result in\nboth new ejections as well as endpoints being returned to service. Defaults\nto 10000ms or 10s. Specified in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 600000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.max_ejection_percent": {
"type": "integer",
"description": "The maximum % of an upstream cluster that can be ejected due to outlier\ndetection. Defaults to 10% but will eject at least one host regardless of the value.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 100,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.panic_threshold": {
"type": "integer",
"description": "Exclusive with [no_panic_threshold]\n\nConfigure a threshold (percentage of unhealthy endpoints) below which\nall endpoints will be considered for loadbalancing ignoring its health status.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 100,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_protocol_v1": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_protocol_v2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters": {
"type": "object",
"description": "TLS configuration for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.cert_params": {
"type": "object",
"description": "Certificate Parameters for authentication, TLS ciphers, and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.common_params": {
"type": "object",
"description": "Information of different aspects for TLS authentication related to ciphers,\ncertificates and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.default_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.disable_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.disable_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.max_session_keys": {
      "type": "integer",
"description": "Exclusive with [default_session_key_caching disable_session_key_caching]\n\nNumber of session keys that are cached.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2,
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.sni": {
"type": "string",
"description": "Exclusive with [disable_sni use_host_header_as_sni]\nSNI value to be used.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.use_host_header_as_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type": {
"type": "object",
"description": "Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.disable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.enable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.http_protocol_type": [
"auto_http_config",
"http1_config",
"http2_options"
],
"spec.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.panic_threshold_type": [
"no_panic_threshold",
"panic_threshold"
],
"spec.proxy_protocol_type": [
"disable_proxy_protocol",
"proxy_protocol_v1",
"proxy_protocol_v2"
],
"spec.http1_config.header_transformation.header_transformation_choice": [
"default_header_transformation",
"preserve_case_header_transformation",
"proper_case_header_transformation"
],
"spec.tls_parameters.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.tls_parameters.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.tls_parameters.tls_params_choice": [
"cert_params",
"common_params"
],
"spec.upstream_conn_pool_reuse_type.map_downstream_to_upstream_conn_pool_type": [
"disable_conn_pool_reuse",
"enable_conn_pool_reuse"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cluster",
"description": "Replace Cluster.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/clusters/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cluster",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cluster.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/clusterReplaceSpecType"
}
],
"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 clusterReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for clusterReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for clusterReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an cluster object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.auto_http_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker": {
"type": "object",
"description": "CircuitBreaker provides a mechanism for watching failures in upstream connections or requests\nand if the failures reach a certain threshold, automatically fail subsequent requests which\nallows to apply back pressure on downstream quickly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.connection_limit": {
"type": "integer",
"description": "The maximum number of connections that loadbalancer will establish to all hosts in an upstream cluster.\nIn practice this is only applicable to TCP and HTTP/1.1 clusters since HTTP/2 uses a single connection to each host.\nRemove endpoint out of load balancing decision, if number of connections reach connection limit.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.max_requests": {
"type": "integer",
"description": "The maximum number of requests that can be outstanding to all hosts in a cluster at any given time.\nIn practice this is applicable to HTTP/2 clusters since HTTP/1.1 clusters are governed by the\nmaximum connections (connection_limit).\nRemove endpoint out of load balancing decision, if requests exceed this count.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.pending_requests": {
"type": "integer",
"description": "The maximum number of requests that will be queued while waiting for a ready connection pool connection.\nSince HTTP/2 requests are sent over a single connection, this circuit breaker only comes into play as the\ninitial connection is created, as requests will be multiplexed immediately afterwards. For HTTP/1.1, requests\nare added to the list of pending requests whenever there aren’t enough upstream connections available to\nimmediately dispatch the request, so this circuit breaker will remain in play for the lifetime of the process.\nRemove endpoint out of load balancing decision, if pending request reach pending_request.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.circuit_breaker.priority": {
"type": "string",
"description": "Priority routing for each request.\nDifferent connection pools are used based on the priority selected for the request.\nAlso, circuit-breaker configuration at destination cluster is chosen based on selected priority.\n\nDefault routing mechanism\nHigh-Priority routing mechanism.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DEFAULT"
},
"spec.circuit_breaker.retries": {
"type": "integer",
"description": "The maximum number of retries that can be outstanding to all hosts in a cluster at any given time.\nRemove endpoint out of load balancing decision, if retries for request exceed this count.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 32768,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to endpoints in the cluster.\nThis is specified in milliseconds. The default value is 2 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_subset": {
"type": "object",
"description": "List of key-value pairs that define default subset. This subset can be referred in fallback_policy\nwhich gets used when route specifies no metadata or no subset matching the metadata exists.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_proxy_protocol": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint_selection": {
"type": "string",
"description": "Policy for selection of endpoints from local site/remote site/both\n\nConsider both remote and local endpoints for load balancing\nLOCAL_ONLY: Consider only local endpoints for load balancing\nEnable this policy to load balance ONLY among locally discovered endpoints\nPrefer the local endpoints for load balancing. If local endpoints are not present\nremote endpoints will be considered.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISTRIBUTED"
},
"spec.endpoint_subsets": {
"type": "array",
"description": "Cluster may be configured to divide its endpoints into subsets based on metadata\nattached to the endpoints. Routes may then specify the metadata that a endpoint must match in\norder to be selected by the load balancer.\n\nEndpoint_subsets is list of subsets for this cluster. Each entry in this list has definition for a subset\n(which is collection of keys)\n\nDuring routing, the route’s metadata match configuration is used to find a specific subset.\nIf there is a subset with the exact keys and values specified by the route, the subset is used\nfor load balancing. Otherwise, the fallback policy is used. The cluster’s subset configuration must,\ntherefore, contain a definition that has the same keys as a given route in order for subset load\nbalancing to occur.\n\nExample:\n\nRouteConfig\n\nroutes:\n- match:\n - headers: []\npath:\npath: /1.log\nquery_params: []\nrouteDestination:\ndestinations:\n - cluster:\n - kind: cluster.object\nuid: 00000000-0000-4000-8000-0b50b89d07a2\nendpointSubsets:\nsite: india\n\nEndpointConfig\n\nmetadata:\nlabels:\ndeployment: debug\nsite: india\nname: end-1\nuid: end-1\n\nClusterConfig\n\ngcSpec:\ndefaultSubset:\nstage: production\nfallbackPolicy: DEFAULT_SUBSET\nendpointSubsets:\n - keys:\n - site\n - keys:\n - stage\n - app\n\nAssume the below endpoints are defined and associated with the cluster.\n\nEndpoint Labels\n-------- ------\n\nep1 stage: production, site: india\nep2 stage: deployment, site: us\nep3 stage: production, app: hr\nep4 site: india\n\nThe following table describes some routes and the result of their application\nto the cluster. The subset definition for cluster is assumed to be same as given\nabove in the ClusterConfig section\n\nRouteMatch Criteria Subset Reason\n------------------- ------ ------\n\nsite: india ep1, ep4 Subset of endpoints selected\nsite: us ep2 Subset of endpoints selected\napp: hr ep1, ep3 Fallback: No subset selector for \"app\" alone\nstage: production, app: hr ep3 Subset of endpoints selected\nother: x ep1, ep3 Fallback: No subset selector for “other”\n(none) ep1, ep3 Fallback: No subset requested.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoints": {
"type": "array",
"description": "List of references to all endpoint objects that belong to this cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.fallback_policy": {
"type": "string",
"description": "Enumeration for SubsetFallbackPolicy if subset match is not found.\n\nThe request fails as if the cluster had no endpoint matching the subset policy\nAny cluster endpoint may be selected if the cluster had no endpoint matching the subset policy\nLoad balancing is done over endpoints matching default_subset if the cluster had no\nendpoint matching the subset policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "NO_FALLBACK"
},
"spec.health_checks": {
"type": "array",
"description": "List of references to healthcheck object for this cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http1_config": {
"type": "object",
"description": "HTTP/1.1 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http1_config.header_transformation": {
"type": "object",
"description": "Header Transformation OPTIONS for HTTP/1.1 request/response headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http2_options": {
"type": "object",
"description": "Http2 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http2_options.enabled": {
"type": "boolean",
"description": "Enable/disable HTTP2 Protocol for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_idle_timeout": {
"type": "integer",
"description": "The idle timeout for upstream connection pool connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 5 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.loadbalancer_algorithm": {
"type": "string",
"description": "Different load balancing algorithms supported\nWhen a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm\nto determine which host is selected.\n\n- ROUND_ROBIN: ROUND_ROBIN\n\nPolicy in which each healthy/available upstream endpoint is selected in round robin order.\n- LEAST_REQUEST: LEAST_REQUEST\n\nPolicy in which loadbalancer picks the upstream endpoint which has the fewest active requests\n- RING_HASH: RING_HASH\n\nPolicy implements consistent hashing to upstream endpoints using ring hash of endpoint names\nHash of the incoming request is calculated using request hash policy.\nThe ring/modulo hash load balancer implements consistent hashing to upstream hosts.\nThe algorithm is based on mapping all hosts onto a circle such that the addition or\nremoval of a host from the host set changes only affect 1/N requests. This technique\nis also commonly known as “ketama” hashing. A consistent hashing load balancer is only\neffective when protocol routing is used that specifies a value to hash on. The minimum\nring size governs the replication factor for each host in the ring. For example, if the\nminimum ring size is 1024 and there are 16 hosts, each host will be replicated 64 times.\n- RANDOM: RANDOM\n\nPolicy in which each available upstream endpoint is selected in random order.\nThe random load balancer selects a random healthy host. The random load balancer generally\nperforms better than round robin if no health checking policy is configured. Random selection\navoids bias towards the host in the set that comes after a failed host.\n- LB_OVERRIDE: Load Balancer Override\n\nHash policy is taken from from the load balancer which is using this origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ROUND_ROBIN"
},
"spec.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\n\nSets the maximum number of requests allowed per connection to the origin server.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_panic_threshold": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection": {
"type": "object",
"description": "Outlier detection and ejection is the process of dynamically determining whether some number\nof hosts in an upstream cluster are performing unlike the others and removing them from the\nhealthy load balancing set. Outlier detection is a form of passive health checking.\n\nAlgorithm\n\n1. A endpoint is determined to be an outlier (based on configured number of consecutive_5xx\nor consecutive_gateway_failures) .\n2. If no endpoints have been ejected, loadbalancer will eject the host immediately.\nOtherwise, it checks to make sure the number of ejected hosts is below the allowed threshold\n(specified via max_ejection_percent setting). If the number of ejected hosts is above the\nthreshold, the host is not ejected.\n3. The endpoint is ejected for some number of milliseconds. Ejection means that the endpoint is marked\nunhealthy and will not be used during load balancing. The number of milliseconds is equal to the\nbase_ejection_time value multiplied by the number of times the host has been ejected.\n4. An ejected endpoint will automatically be brought back into service after the ejection time\nhas been satisfied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.base_ejection_time": {
"type": "integer",
"description": "The base time that a host is ejected for. The real time is equal to the\nbase time multiplied by the number of times the host has been ejected.\nThis causes hosts to GET ejected for longer periods if they continue to fail.\nDefaults to 30000ms or 30s. Specified in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.consecutive_5xx": {
"type": "integer",
"description": "If an upstream endpoint returns some number of consecutive 5xx, it will be ejected.\nNote that in this case a 5xx means an actual 5xx respond code, or an event that would\ncause the HTTP router to return one on the upstream’s behalf(reset, connection failure, etc.)\nconsecutive_5xx indicates the number of consecutive 5xx responses required before\na consecutive 5xx ejection occurs. Defaults to 5.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.consecutive_gateway_failure": {
"type": "integer",
"description": "If an upstream endpoint returns some number of consecutive “gateway errors”\n(502, 503 or 504 status code), it will be ejected. Note that this includes events\nthat would cause the HTTP router to return one of these status codes on the\nupstream’s behalf (reset, connection failure, etc.).\nConsecutive_gateway_failure indicates the number of consecutive gateway failures\nbefore a consecutive gateway failure ejection occurs. Defaults to 5.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.interval": {
"type": "integer",
"description": "The time interval between ejection analysis sweeps. This can result in\nboth new ejections as well as endpoints being returned to service. Defaults\nto 10000ms or 10s. Specified in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 600000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outlier_detection.max_ejection_percent": {
"type": "integer",
"description": "The maximum % of an upstream cluster that can be ejected due to outlier\ndetection. Defaults to 10% but will eject at least one host regardless of the value.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 100,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.panic_threshold": {
"type": "integer",
"description": "Exclusive with [no_panic_threshold]\n\nConfigure a threshold (percentage of unhealthy endpoints) below which\nall endpoints will be considered for loadbalancing ignoring its health status.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 100,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_protocol_v1": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_protocol_v2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters": {
"type": "object",
"description": "TLS configuration for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.cert_params": {
"type": "object",
"description": "Certificate Parameters for authentication, TLS ciphers, and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.common_params": {
"type": "object",
"description": "Information of different aspects for TLS authentication related to ciphers,\ncertificates and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.default_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.disable_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.disable_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.max_session_keys": {
      "type": "integer",
"description": "Exclusive with [default_session_key_caching disable_session_key_caching]\n\nNumber of session keys that are cached.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2,
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.sni": {
"type": "string",
"description": "Exclusive with [disable_sni use_host_header_as_sni]\nSNI value to be used.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.use_host_header_as_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type": {
"type": "object",
"description": "Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.disable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.enable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.http_protocol_type": [
"auto_http_config",
"http1_config",
"http2_options"
],
"spec.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.panic_threshold_type": [
"no_panic_threshold",
"panic_threshold"
],
"spec.proxy_protocol_type": [
"disable_proxy_protocol",
"proxy_protocol_v1",
"proxy_protocol_v2"
],
"spec.http1_config.header_transformation.header_transformation_choice": [
"default_header_transformation",
"preserve_case_header_transformation",
"proper_case_header_transformation"
],
"spec.tls_parameters.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.tls_parameters.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.tls_parameters.tls_params_choice": [
"cert_params",
"common_params"
],
"spec.upstream_conn_pool_reuse_type.map_downstream_to_upstream_conn_pool_type": [
"disable_conn_pool_reuse",
"enable_conn_pool_reuse"
]
}
},
{
"name": "list_clusters",
"description": "List Cluster.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/clusters",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cluster",
"description": "DELETE Cluster.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/clusters/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cluster",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cluster.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for clusterDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for clusterDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_cluster",
"description": "GET Cluster.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/clusters/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"cminstances": {
"name": "cminstances",
"displayName": "Cminstances",
"operations": [
{
"name": "create_cminstance",
"description": "Create Central Manager Instance.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cminstances",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of cminstance",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.cminstance.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/cminstanceCreateSpecType"
}
],
"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 cminstanceCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cminstanceCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "marketplace"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cminstanceCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create App type will create the configuration in namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_token": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_token.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_token.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip": {
"type": "object",
"description": "IPv4 Address in dot-decimal notation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip.addr": {
"type": "string",
"description": "IPv4 Address in string form with dot-decimal notation.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Port of the Central Manager instance to connect to.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.username": {
"type": "string",
"description": "Username for the Central Manager instance.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 4,
"maxLength": 128,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.api_token.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_cminstance",
"description": "Replace Central Manager Instance.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/cminstances/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a cminstance",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.cminstance.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/cminstanceReplaceSpecType"
}
],
"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 cminstanceReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cminstanceReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "marketplace"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cminstanceReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_token": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_token.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_token.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip": {
"type": "object",
"description": "IPv4 Address in dot-decimal notation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip.addr": {
"type": "string",
"description": "IPv4 Address in string form with dot-decimal notation.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Port of the Central Manager instance to connect to.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.username": {
"type": "string",
"description": "Username for the Central Manager instance.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 4,
"maxLength": 128,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.api_token.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_cminstances",
"description": "List Central Manager Instance.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cminstances",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_cminstance",
"description": "DELETE Central Manager Instance.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cminstances/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a cminstance",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.cminstance.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cminstanceDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cminstanceDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "marketplace"
}
},
{
"name": "get_cminstance",
"description": "GET Central Manager Instance.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cminstances/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"code-base-integrations": {
"name": "code-base-integrations",
"displayName": "Code Base Integrations",
"operations": [
{
"name": "create_code_base_integration",
"description": "CREATE Code Base Integration.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/code_base_integrations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of code_base_integration",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.code_base_integration.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/code_base_integrationCreateSpecType"
}
],
"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 code_base_integrationCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for code_base_integrationCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for code_base_integrationCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "CREATE integration details.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration": {
"type": "object",
"description": "Choose your code base (e.g. GitHub, GitLab, Bitbucket, Azure) and provide credentials and connection details.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.azure_repos": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.bitbucket": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.bitbucket_server": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.github": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.github_enterprise": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.gitlab": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.gitlab_enterprise": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.code_base_integration.type": [
"azure_repos",
"bitbucket",
"bitbucket_server",
"github",
"github_enterprise",
"gitlab",
"gitlab_enterprise"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_code_base_integration",
"description": "Replace Code Base Integration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/code_base_integrations/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a code_base_integration",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.code_base_integration.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/code_base_integrationReplaceSpecType"
}
],
"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 code_base_integrationReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for code_base_integrationReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for code_base_integrationReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace integration details.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration": {
"type": "object",
"description": "Choose your code base (e.g. GitHub, GitLab, Bitbucket, Azure) and provide credentials and connection details.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.azure_repos": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.bitbucket": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.bitbucket_server": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.github": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.github_enterprise": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.gitlab": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.code_base_integration.gitlab_enterprise": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.code_base_integration.type": [
"azure_repos",
"bitbucket",
"bitbucket_server",
"github",
"github_enterprise",
"gitlab",
"gitlab_enterprise"
]
}
},
{
"name": "list_code_base_integrations",
"description": "List Code Base Integration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/code_base_integrations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_code_base_integration",
"description": "DELETE Code Base Integration.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/code_base_integrations/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a code_base_integration",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.code_base_integration.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for code_base_integrationDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for code_base_integrationDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      }
},
{
"name": "get_code_base_integration",
"description": "GET Code Base Integration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/code_base_integrations/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"comment": {
"name": "comment",
"displayName": "Comment",
"operations": [
{
"name": "create_comment",
"description": "Add comment to a customer support ticket.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/customer_support/{name}/comment",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Adds a new comment to an existing customer support ticket.",
"title": "Add comment request",
"x-displayname": "Customer support ticket comment.",
"x-ves-proto-message": "ves.io.schema.customer_support.CommentRequest",
"properties": {
"attachments": {
"type": "array",
"description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"title": "Binary attachments",
"items": {
"$ref": "#/components/schemas/customer_supportAttachmentType"
},
"x-displayname": "Attachments.",
"x-f5xc-description-short": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"comment": {
"type": "string",
"description": "The name of the customer support ticket object to be updated.",
"title": "comment",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the customer support ticket object to be updated.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be updated.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the customer support ticket object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Adds a new comment to an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportCommentRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportCommentRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportCommentRequest"
},
"fieldMetadata": {
"attachments": {
"type": "array",
"description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"comment": {
"type": "string",
"description": "The name of the customer support ticket object to be updated.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"connectivity": {
"name": "connectivity",
"displayName": "Connectivity",
"operations": [
{
"name": "create_connectivity",
"description": "Connectivity Graph Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/connectivity",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data\nfor the tenant's CEs and the connected REs.",
      "title": "Connectivity Graph Request",
"x-displayname": "Connectivity Graph Request.",
"x-ves-proto-message": "ves.io.schema.graph.connectivity.Request",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/connectivityFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by site.\n\nOptional: If not specified, then the data is aggregated/grouped by site.",
"title": "group_by",
"items": {
"$ref": "#/components/schemas/connectivityIdField"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, connectivity data for all sites will be returned in the response.",
      "title": "label_filter",
"items": {
"$ref": "#/components/schemas/connectivityLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, connectivity data for all sites will be returned in the response.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data for the tenant's CEs and the connected REs.",
      "x-f5xc-description-medium": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data for the tenant's CEs and the connected REs.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for connectivityRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for connectivityRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for connectivityRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "FieldSelector is used to specify the list of fields to be returned in the response for connectivity graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by site.\n\nOptional: If not specified, then the data is aggregated/grouped by site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, connectivity data for all sites will be returned in the response.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "Connectivity data between the the Customer sites and the Regional sites."
},
{
"field": "nodes",
"type": "array",
"description": "Connectivity data for list of sites owned by a tenant."
}
]
}
]
},
	"connectivity-edge": {
"name": "connectivity-edge",
"displayName": "Connectivity Edge",
"operations": [
{
"name": "create_connectivity_edge",
"description": "Connectivity Edge Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/connectivity/edge",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the time-series data for an edge in the connectivity graph.\nWhile graph/connectivity API is used to GET connectivity data for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/connectivity/edge API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.",
      "title": "Connectivity Edge Request",
"x-displayname": "Connectivity Edge Request.",
"x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeRequest",
"properties": {
"dst_id": {
"allOf": [
{
"$ref": "#/components/schemas/connectivityId"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/connectivityEdgeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id": {
"allOf": [
{
"$ref": "#/components/schemas/connectivityId"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the time-series data for an edge in the connectivity graph.",
"x-f5xc-description-medium": "Request to GET the time-series data for an edge in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/edge API is used to GET the time-series data...",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for connectivityEdgeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for connectivityEdgeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for connectivityEdgeRequest"
},
"fieldMetadata": {
"dst_id": {
"type": "object",
"description": "ID uniquely identifies a node or an edge in the connectivity graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.site_type": {
"type": "string",
"description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INVALID"
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.types": {
"type": "array",
"description": "Specify list of metrics that should be returned for each edge in the connectivity graph.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id": {
"type": "object",
"description": "ID uniquely identifies a node or an edge in the connectivity graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.site_type": {
"type": "string",
"description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INVALID"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"connectivity-node": {
"name": "connectivity-node",
"displayName": "Connectivity Node",
"operations": [
{
"name": "create_connectivity_node",
"description": "Connectivity Node Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/connectivity/node",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET time-series data for a node in the connectivity graph.\nWhile graph/connectivity API is used to GET connectivity data for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/connectivity/node API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.",
      "title": "Connectivity Node Request",
"x-displayname": "Connectivity Node Request.",
"x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/connectivityNodeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by site.\n\nOptional: If not specified, then the data is aggregated/grouped by site.",
"title": "group_by",
"maxItems": 4,
"items": {
"$ref": "#/components/schemas/connectivityIdField"
},
"x-displayname": "Group By",
"x-ves-validation-rules": {
"ves.io.schema.rules.enum.defined_only": "true",
"ves.io.schema.rules.repeated.max_items": "4",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.enum.defined_only": "true",
"ves.io.schema.rules.repeated.max_items": "4",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/connectivityId"
}
],
"x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, connectivity data for all sites will be returned in the response.",
      "title": "label_filter",
"items": {
"$ref": "#/components/schemas/connectivityLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, connectivity data for all sites will be returned in the response.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET time-series data for a node in the connectivity graph.",
"x-f5xc-description-medium": "Request to GET time-series data for a node in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/node API is used to GET the time-series data (drill-down of...",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for connectivityNodeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for connectivityNodeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for connectivityNodeRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.instances": {
"type": "array",
"description": "Specify list of metrics.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.interfaces": {
"type": "array",
"description": "Specify list of metrics that should be returned for each physical interface in a site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.types": {
"type": "array",
"description": "Specify list of metrics that should be returned for each node in the connectivity graph.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by site.\n\nOptional: If not specified, then the data is aggregated/grouped by site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "object",
"description": "ID uniquely identifies a node or an edge in the connectivity graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.site_type": {
"type": "string",
"description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INVALID"
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, connectivity data for all sites will be returned in the response.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"contacts": {
"name": "contacts",
"displayName": "Contacts",
"operations": [
{
"name": "create_contact",
"description": "Create Contact.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/contacts",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of contact",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.contact.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/contactCreateSpecType"
}
],
"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 contactCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for contactCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for contactCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new customer's contact detail record with us, including address and phone number.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"spec.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_contact",
"description": "Replace Contact.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/contacts/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a contact",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.contact.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/contactReplaceSpecType"
}
],
"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 contactReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for contactReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for contactReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Updates existing customer's contact details, including address and phone number.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"spec.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_contacts",
"description": "List Contact.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/contacts",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_contact",
"description": "DELETE Contact.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/contacts/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a contact",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.contact.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for contactDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for contactDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_contact",
"description": "GET Contact.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/contacts/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"container-registrys": {
"name": "container-registrys",
"displayName": "Container Registrys",
"operations": [
{
"name": "create_container_registry",
"description": "Create Container Registry.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/container_registrys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of container_registry",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.container_registry.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/container_registryCreateSpecType"
}
],
"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 container_registryCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for container_registryCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for container_registryCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of Container Registry.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.email": {
"type": "string",
"description": "Email used for the registry.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.registry": {
"type": "string",
"description": "Fully qualified name of the registry login server.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_name": {
"type": "string",
"description": "Username used to access the registry.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_container_registry",
"description": "Replace Container Registry.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/container_registrys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a container_registry",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.container_registry.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/container_registryReplaceSpecType"
}
],
"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 container_registryReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for container_registryReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for container_registryReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of Container Registry.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.email": {
"type": "string",
"description": "Email used for the registry.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.registry": {
"type": "string",
"description": "Fully qualified name of the registry login server.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_name": {
"type": "string",
"description": "Username used to access the registry.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_container_registrys",
"description": "List Container Registry.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/container_registrys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_container_registry",
"description": "DELETE Container Registry.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/container_registrys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a container_registry",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.container_registry.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for container_registryDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for container_registryDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
}
},
{
"name": "get_container_registry",
"description": "GET Container Registry.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/container_registrys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"create": {
"name": "create",
"displayName": "Create",
"operations": [
{
"name": "create_create",
"description": "Create",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/known_label/create",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Create label request in shared namespace. Only shared namespace supported.",
"title": "Create Label Request",
"x-displayname": "Create Label Request.",
"x-ves-proto-message": "ves.io.schema.known_label.CreateRequest",
"properties": {
"description": {
"type": "string",
"description": "Description of the label to be created.",
"title": "Description",
"x-displayname": "Description.",
"x-ves-example": "Paris metro region in France (EU)",
"x-f5xc-example": "Paris metro region in France (EU)",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"key": {
      "type": "string",
"description": "Key for the label to be created.",
      "title": "Key",
      "x-displayname": "Key",
      "x-ves-example": "VES.I/O/region.",
"x-f5xc-example": "F5 XC/region",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which to create the label.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"value": {
"type": "string",
"description": "Value of the label to be created.",
"title": "Value",
"x-displayname": "Value",
"x-ves-example": "VES-I/O-par.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.k8s_label_value": "true"
},
"x-f5xc-example": "ves-io-par",
"x-validation-rules": {
"ves.io.schema.rules.string.k8s_label_value": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Create label request in shared namespace. Only shared namespace supported.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for known_labelCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for known_labelCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "users"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for known_labelCreateRequest"
},
"fieldMetadata": {
"description": {
"type": "string",
"description": "Description of the label to be created.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"key": {
      "type": "string",
"description": "Key for the label to be created.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which to create the label.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"value": {
"type": "string",
"description": "Value of the label to be created.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "label",
"type": "object",
"description": ""
}
]
}
]
},
	"create-ticket": {
"name": "create-ticket",
"displayName": "Create Ticket",
"operations": [
{
"name": "create_create_ticket",
"description": "Create a ticket for a vulnerability.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/create_ticket",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"title": "CreateTicketRequest",
"x-displayname": "Create Ticket Request.",
"x-ves-proto-message": "ves.io.schema.virtual_host.CreateTicketRequest",
"properties": {
"jira_issue": {
"allOf": [
{
"$ref": "#/components/schemas/virtual_hostCreateJiraIssueRequest"
}
],
"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-validation-rules": {
"ves.io.schema.rules.map.max_pairs": "16"
},
"x-validation-rules": {
"ves.io.schema.rules.map.max_pairs": "16"
},
"x-f5xc-example": "{\"key\": \"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": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"maxLength": 256,
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "blogging-app-vhost",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the ticket.",
"title": "namespace",
"maxLength": 256,
"x-displayname": "Namespace",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"ticket_tracking_system": {
"type": "string",
"description": "The primary identifier (name) of the ticket tracking system system.",
"title": "ticket_tracking_system",
"minLength": 1,
"maxLength": 256,
"x-displayname": "Ticket Tracking System.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "The primary identifier (name) of the ticket tracking system system.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostCreateTicketRequest",
"required_fields": [
"name",
"namespace",
"ticket_tracking_system"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostCreateTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  ticket_tracking_system: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"ticket_tracking_system\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"ticket_tracking_system": "value"
}
},
"requiredFields": [
"name",
"namespace",
"ticket_tracking_system"
],
"description": "Minimum configuration for virtual_hostCreateTicketRequest"
},
"fieldMetadata": {
"jira_issue": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"jira_issue.description": {
"type": "string",
"description": "Optional description.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"jira_issue.issue_type": {
"type": "string",
"description": "Name of the issue type.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"jira_issue.project": {
"type": "string",
"description": "External ID of the project.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"jira_issue.summary": {
"type": "string",
"description": "Configuration parameter for summary",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the ticket.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ticket_tracking_system": {
"type": "string",
"description": "The primary identifier (name) of the ticket tracking system system.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors related to ticket creation."
}
]
}
]
},
	"crls": {
"name": "crls",
"displayName": "Crls",
"operations": [
{
"name": "create_crl",
"description": "Create CRL.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/crls",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"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_yaml": "# Minimal example for crlCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for crlCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to create CRL object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_access": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_access.path": {
      "type": "string",
"description": "CRL file location.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.refresh_interval": {
"type": "integer",
"description": "CRL refresh interval, in hours.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 6,
"maximum": 168,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.server_address": {
"type": "string",
"description": "CRL server address or hostname.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.server_port": {
"type": "integer",
"description": "Set CRL Server port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.timeout": {
"type": "integer",
"description": "CRL download wait time, in seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 180,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.access_info_choice": [
      "http_access"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_crl",
"description": "Replace CRL.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/crls/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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_yaml": "# Minimal example for crlReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for crlReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to replace CRL object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_access": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_access.path": {
      "type": "string",
"description": "CRL file location.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.refresh_interval": {
"type": "integer",
"description": "CRL refresh interval, in hours.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 6,
"maximum": 168,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.server_address": {
"type": "string",
"description": "CRL server address or hostname.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.server_port": {
"type": "integer",
"description": "Set CRL Server port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.timeout": {
"type": "integer",
"description": "CRL download wait time, in seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 180,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.access_info_choice": [
      "http_access"
      ]
}
},
{
"name": "list_crls",
"description": "List CRL",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/crls",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_crl",
"description": "DELETE CRL.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/crls/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for crlDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for crlDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
}
},
{
"name": "get_crl",
"description": "GET CRL",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/crls/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"current-usage": {
"name": "current-usage",
"displayName": "Current Usage",
"operations": [
{
"name": "create_current_usage",
"description": "List current usage details.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/current_usage",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request message to GET current usage details.",
"title": "List current usage details request",
"x-displayname": "List current usage details request.",
"x-ves-proto-message": "ves.io.schema.usage.ListCurrentUsageReq",
"properties": {
"from": {
"type": "string",
"description": "Indicates the \"from\" part of the request.",
"title": "Timestamp from",
"format": "date-time",
"x-displayname": "From",
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
"x-f5xc-description-short": "Indicates the \"from\" part of the request.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"to": {
"type": "string",
"description": "Indicates the \"to\" part of the request.",
"title": "Timestamp to",
"format": "date-time",
"x-displayname": "To",
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request message to GET current usage details.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usageListCurrentUsageReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usageListCurrentUsageReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"coupons": {
"type": "array"
},
"discount": {
"type": "string"
},
"total_cost": {
"type": "string"
},
"usage_items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usageListCurrentUsageReq"
},
"fieldMetadata": {
"from": {
"type": "string",
"description": "Indicates the \"from\" part of the request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"to": {
"type": "string",
"description": "Indicates the \"to\" part of the request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "coupons",
"type": "array",
"description": "All used coupons."
},
{
"field": "discount",
"type": "string",
"description": "Discount as hundredths of currency."
},
{
"field": "total_cost",
"type": "string",
"description": "Total cost as hundredths of currency."
},
{
"field": "usage_items",
"type": "array",
"description": "Collection of usage items, lines of response."
}
]
}
]
},
	"custom": {
"name": "custom",
"displayName": "Custom",
"operations": [
{
"name": "create_custom",
"description": "Accept TOS.",
"method": "POST",
"path": "/api/web/custom/namespaces/{namespace}/accept_tos",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Accept TOS request model.",
"title": "Accept TOS request model",
"x-displayname": "Accept TOS Request.",
"x-ves-proto-message": "ves.io.schema.user.AcceptTOSRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"tos_accepted": {
"type": "string",
"description": "Tos accepted version, this field is deprecated refer the fields `tos_accepted_at` and `tos_version` instead.",
"title": "tos_accepted",
"x-displayname": "TOS Accepted.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Tos accepted version, this field is deprecated refer the fields and instead.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tos_accepted_at": {
"type": "string",
"description": "Tos accepted timestamp in epoch.",
"title": "tos_accepted_at",
"format": "int64",
"x-displayname": "TOS Accepted Timestamp.",
"x-ves-example": "1628490105132.",
"x-f5xc-example": "1628490105132",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tos_version": {
"type": "string",
"description": "Tos accepted version.",
"title": "tos_version",
"x-displayname": "TOS version.",
"x-ves-example": "V1.0",
"x-f5xc-example": "v1.0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for userAcceptTOSRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for userAcceptTOSRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for userAcceptTOSRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tos_accepted": {
"type": "string",
"description": "Tos accepted version, this field is deprecated refer the fields `tos_accepted_at` and `tos_version` instead.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tos_accepted_at": {
"type": "string",
"description": "Tos accepted timestamp in epoch.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tos_version": {
"type": "string",
"description": "Tos accepted version.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "get_custom",
"description": "GET",
"method": "GET",
"path": "/api/web/custom/namespaces/{namespace}/oidc_provider/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "object",
"type": "object",
"description": ""
}
]
},
{
"name": "list_custom",
"description": "List",
"method": "GET",
"path": "/api/web/custom/namespaces/{namespace}/oidc_providers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of OIDC providers."
}
]
},
{
"name": "replace_custom",
"description": "Replace",
"method": "PUT",
"path": "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "ReplaceRequest is the request format for replacing an OIDC provider in IAM.",
"title": "Replace Request",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.oidc_provider.ReplaceRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the oidc_provider object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Google",
"x-f5xc-example": "google",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Supports only system namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemaoidc_providerCustomCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "ReplaceRequest is the request format for replacing an OIDC provider in IAM.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for oidc_providerReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for oidc_providerReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for oidc_providerReplaceRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the oidc_provider object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Supports only system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "CustomCreateSpecType is the spec to create OIDC provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type": {
"type": "object",
"description": "AzureOIDCSpecType specifies the attributes required to configure Azure provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.authorization_url": {
      "type": "string",
"description": "The authorization URL of your OIDC application.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.backchannel_logout": {
"type": "boolean",
"description": "Does the external IDP support backchannel logout?",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.client_id": {
"type": "string",
"description": "Client ID of the OIDC application registered with Azure provider.\nREQUIRED field.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.client_secret": {
      "type": "string",
"description": "Secret of the OIDC application registered with Azure provider.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.default_scopes": {
"type": "string",
"description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.issuer": {
"type": "string",
"description": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.jwks_url": {
"type": "string",
"description": "URL where identity provider keys in JWK format are stored.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.logout_url": {
"type": "string",
"description": "Logout URL specified in your OIDC application.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.prompt": {
"type": "string",
"description": "Type of prompt authorization server for end-user reauthentication and consent\n\ndefault value for no prompt. When this is set, no prompt parameter will be set on authorization request.\nThe Authorization Server will not display any authentication or consent user interface page.\nThe Authorization Server prompts the End-User for consent before returning information to the Client\nThe Authorization Server prompts the End-User for reauthentication.\nThe Authorization Server prompts the End-User to select a user account.\nThis enables an End-User who has multiple accounts at the Authorization Server to select amongst\nthe multiple accounts that they might have current sessions for.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNSPECIFIED"
},
"spec.azure_oidc_spec_type.token_url": {
      "type": "string",
"description": "The token URL of your OIDC application.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_oidc_spec_type.user_info_url": {
"type": "string",
"description": "The User Info URL specified in your OIDC application.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.google_oidc_spec_type": {
"type": "object",
"description": "GoogleOIDCSpecType specifies the attributes required to configure google provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.google_oidc_spec_type.client_id": {
"type": "string",
"description": "Client ID of the OIDC application registered with google provider.\nREQUIRED field.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.google_oidc_spec_type.client_secret": {
      "type": "string",
"description": "Secret of the OIDC application registered with google provider.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.google_oidc_spec_type.hosted_domain": {
"type": "string",
"description": "Set hosted domain to restrict user input on login form to use email address from this email domain.\nFor example, setting value company.com will enforce user email input to have only dana@example.com\nleave empty if no restriction is required for email address. Ie for example allow dana@example.com and dana@example.com.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type": {
"type": "object",
"description": "OIDCV10SpecType specifies the attributes required to configure OIDC provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.allowed_clock_skew": {
"type": "string",
"description": "Clock skew in seconds that is tolerated when validating identity provider tokens. Default value is zero.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.authorization_url": {
      "type": "string",
"description": "The authorization URL of your OIDC application.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.backchannel_logout": {
"type": "boolean",
"description": "Does the external IDP support backchannel logout?",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.client_id": {
"type": "string",
"description": "Client ID of the OIDC application registered with your identity/OIDC provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.client_secret": {
      "type": "string",
"description": "Secret of the OIDC application registered with your identity/OIDC provider.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.default_scopes": {
"type": "string",
"description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.disable_user_info": {
"type": "boolean",
"description": "Disable fetching of user info information.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.display_name": {
"type": "string",
"description": "Friendly name for identity provider.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.forwarded_query_parameters": {
"type": "string",
"description": "Non OpenID Connect/OAuth standard query parameters to be forwarded to external IDP from the initial application request\nto Authorization Endpoint. Multiple parameters can be entered, separated by comma (,).",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.issuer": {
"type": "string",
"description": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.jwks_url": {
"type": "string",
"description": "URL where identity provider keys in JWK format are stored.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.logout_url": {
"type": "string",
"description": "Logout URL specified in your OIDC application.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.pass_current_locale": {
"type": "boolean",
"description": "Pass the current locale to the identity provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.pass_login_hint": {
"type": "boolean",
"description": "Pass login_hint to identity provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.prompt": {
"type": "string",
"description": "Type of prompt authorization server for end-user reauthentication and consent\n\ndefault value for no prompt. When this is set, no prompt parameter will be set on authorization request.\nThe Authorization Server will not display any authentication or consent user interface page.\nThe Authorization Server prompts the End-User for consent before returning information to the Client\nThe Authorization Server prompts the End-User for reauthentication.\nThe Authorization Server prompts the End-User to select a user account.\nThis enables an End-User who has multiple accounts at the Authorization Server to select amongst\nthe multiple accounts that they might have current sessions for.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNSPECIFIED"
},
"spec.oidc_v10_spec_type.token_url": {
      "type": "string",
"description": "The token URL of your OIDC application.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.user_info_url": {
"type": "string",
"description": "The User Info URL specified in your OIDC application.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oidc_v10_spec_type.validate_signatures": {
"type": "boolean",
"description": "Enable/disable signature validation of external IDP signatures.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type": {
"type": "object",
"description": "OKTAOIDCSpecType specifies the attributes required to configure okta OIDC provider.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.authorization_url": {
      "type": "string",
"description": "The authorization URL of your OIDC application.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.backchannel_logout": {
"type": "boolean",
"description": "Does the external IDP support backchannel logout?",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.client_id": {
"type": "string",
"description": "Client ID of the OIDC application registered with Azure provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.client_secret": {
      "type": "string",
"description": "Secret of the OIDC application registered with Azure provider.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.default_scopes": {
"type": "string",
"description": "The scopes to be sent when asking for authorization. It can be a space-separated list of scopes. The recommendation is to set the default scopes as 'openid profile email' and is to add additional scopes if needed.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.issuer": {
"type": "string",
"description": "The issuer identifier for the issuer of the response. If not provided, no validation will be performed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.jwks_url": {
"type": "string",
"description": "URL where identity provider keys in JWK format are stored.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.logout_url": {
"type": "string",
"description": "Logout URL specified in your OIDC application.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.prompt": {
"type": "string",
"description": "Type of prompt authorization server for end-user reauthentication and consent\n\ndefault value for no prompt. When this is set, no prompt parameter will be set on authorization request.\nThe Authorization Server will not display any authentication or consent user interface page.\nThe Authorization Server prompts the End-User for consent before returning information to the Client\nThe Authorization Server prompts the End-User for reauthentication.\nThe Authorization Server prompts the End-User to select a user account.\nThis enables an End-User who has multiple accounts at the Authorization Server to select amongst\nthe multiple accounts that they might have current sessions for.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNSPECIFIED"
},
"spec.okta_oidc_spec_type.token_url": {
      "type": "string",
"description": "The token URL of your OIDC application.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.okta_oidc_spec_type.user_info_url": {
"type": "string",
"description": "The User Info URL specified in your OIDC application.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.provider_type": {
"type": "string",
"description": "Types of OIDC providers\n\nDefault provider. Use this for standard OpenIDConnect v1.0\nAuthenticate with Google OIDC\nAuthenticate with Azure OIDC\nAuthenticate with Okta OIDC.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DEFAULT"
}
},
"oneOfVariants": {
"spec.oidcproviderspec": [
"azure_oidc_spec_type",
"google_oidc_spec_type",
"oidc_v10_spec_type",
"okta_oidc_spec_type"
]
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-addon-services": {
"name": "custom-addon-services",
"displayName": "Custom Addon Services",
"operations": [
{
"name": "get_custom_addon_service",
"description": "GET Addon Service Details.",
"method": "GET",
"path": "/api/web/custom/namespaces/shared/addon_services/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"addon_service_group_display_name": {
"type": "string"
},
"addon_service_group_name": {
"type": "string"
},
"display_name": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "addon_service_group_display_name",
"type": "string",
"description": "Display name of the addon service group."
},
{
"field": "addon_service_group_name",
"type": "string",
"description": "Name of the addon service group."
},
{
"field": "display_name",
"type": "string",
"description": "Display Name of the addon service."
},
{
"field": "managed_activation",
"type": "object",
"description": ""
},
{
"field": "partially_managed_activation",
"type": "object",
"description": ""
},
{
"field": "self_activation",
"type": "object",
"description": ""
},
{
"field": "tier",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-cascade-delete": {
"name": "custom-cascade-delete",
"displayName": "Custom Cascade Delete",
"operations": [
{
"name": "create_custom_cascade_delete",
"description": "DELETE User and Related Objects.",
"method": "POST",
"path": "/api/web/custom/namespaces/{namespace}/users/cascade_delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects.\nNote: only admin is allowed to DELETE the user and associated objects.",
"title": "CascadeDeleteRequest",
"x-displayname": "DELETE the User and Associated Namespace Roles.",
"x-ves-proto-message": "ves.io.schema.user.CascadeDeleteRequest",
"properties": {
"email": {
"type": "string",
"description": "Email of the user requesting for.",
"title": "email of the user",
"x-displayname": "Email",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\"",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects.",
"x-f5xc-description-medium": "CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for userCascadeDeleteRequest",
"required_fields": [
"email"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for userCascadeDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  email: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"email\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"delete_ok": {
"type": "boolean"
},
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"email": "value"
}
},
"requiredFields": [
"email"
],
"description": "Minimum configuration for userCascadeDeleteRequest"
},
"fieldMetadata": {
"email": {
"type": "string",
"description": "Email of the user requesting for.",
"constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "delete_ok",
"type": "boolean",
"description": "Status of the deleted objects.\n\"true\" value indicates that the operation had been successful for all the objects.\n\"false\" value indicates that at least one of the DELETE operations had been unsuccessful."
},
{
"field": "items",
"type": "array",
"description": "The objects deleted for the specific user."
}
]
}
]
},
	"custom-countries": {
"name": "custom-countries",
"displayName": "Custom Countries",
"operations": [
{
"name": "get_custom_countrie",
"description": "List countries.",
"method": "GET",
"path": "/api/web/custom/countries/{prefix}",
      "dangerLevel": "low",
"parameters": [
{
"name": "prefix",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"countries": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "countries",
"type": "array",
"description": "List of all countries supported by the platform."
}
]
}
]
},
	"custom-countries-states": {
"name": "custom-countries-states",
"displayName": "Custom Countries States",
"operations": [
{
"name": "get_custom_countries_state",
"description": "List states.",
"method": "GET",
"path": "/api/web/custom/countries/{country_code}/states/{prefix}",
      "dangerLevel": "low",
"parameters": [
{
"name": "country_code",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "prefix",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"states": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "error_code",
"type": "object",
"description": ""
},
{
"field": "states",
"type": "array",
"description": "List of all states of a country supported by the platform."
}
]
}
]
},
	"custom-countries-states-cities": {
"name": "custom-countries-states-cities",
"displayName": "Custom Countries States Cities",
"operations": [
{
"name": "get_custom_countries_states_citie",
"description": "List cities.",
"method": "GET",
"path": "/api/web/custom/countries/{country_code}/states/{state_code}/cities/{prefix}",
      "dangerLevel": "low",
"parameters": [
{
"name": "country_code",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "state_code",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "prefix",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"cities": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "cities",
"type": "array",
"description": "List of all cities in."
},
{
"field": "error_code",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-dashboards-current-layout": {
"name": "custom-dashboards-current-layout",
"displayName": "Custom Dashboards Current Layout",
"operations": [
{
"name": "list_custom_dashboards_current_layout",
"description": "GET Current Default Dashboard Layout.",
"method": "GET",
"path": "/api/web/custom/namespaces/system/dashboards/{dashboard_id}/current_layout",
      "dangerLevel": "low",
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-dashboards-layouts": {
"name": "custom-dashboards-layouts",
"displayName": "Custom Dashboards Layouts",
"operations": [
{
"name": "list_custom_dashboards_layouts",
"description": "List Dashboard Layouts.",
"method": "GET",
"path": "/api/web/custom/namespaces/system/dashboards/{dashboard_id}/layouts",
      "dangerLevel": "low",
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"layout_list": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "layout_list",
"type": "array",
"description": "LayoutList lists information about dashboards created by the user."
}
]
},
{
"name": "create_custom_dashboards_layout",
"description": "Create Dashboard Layout.",
"method": "POST",
"path": "/api/web/custom/namespaces/system/dashboards/{dashboard_id}/layouts",
      "dangerLevel": "medium",
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "CreateDashboardLayoutRequest contains details to create or update a dashboard layout.",
"title": "CreateDashboardLayoutRequest",
"x-displayname": "CreateDashboardLayoutRequest.",
"x-ves-proto-message": "ves.io.schema.ui.dashboard_layout.CreateDashboardLayoutRequest",
"properties": {
"dashboard_id": {
"type": "string",
"description": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"title": "DashboardId",
"x-displayname": "DashboardId.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"x-f5xc-description-medium": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"description": {
"type": "string",
"description": "Description describes the dashboard layout.",
"title": "Description",
"x-displayname": "Description.",
"x-f5xc-description-short": "Description describes the dashboard layout.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"is_selected": {
"type": "boolean",
"description": "IsSelected indicates whether the current layout is the default selected by the user.",
"title": "IsSelected",
"format": "boolean",
"x-displayname": "IsSelected.",
"x-f5xc-description-short": "IsSelected indicates whether the current layout is the default selected by the user.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_shared": {
"type": "boolean",
"description": "IsShared is a boolean flag when set to true users in the tenant can utilize the same dashboard layout.",
"title": "IsShared",
"format": "boolean",
"x-displayname": "IsShared",
"x-f5xc-description-short": "IsShared is a boolean flag when set to true users in the tenant can utilize the same dashboard layout.",
"x-f5xc-description-medium": "IsShared is a boolean flag when set to true users in the tenant can utilize the same dashboard layout.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_data": {
"type": "object",
"description": "LayoutData holds the layout structure encoded as a JSON.",
"title": "LayoutData",
"x-displayname": "LayoutData.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "LayoutData holds the layout structure encoded as a JSON.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_name": {
"type": "string",
"description": "LayoutName is the name of the dashboard layout.",
"title": "LayoutName",
"minLength": 1,
"maxLength": 256,
"x-displayname": "LayoutName.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "LayoutName is the name of the dashboard layout.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "CreateDashboardLayoutRequest contains details to create or update a dashboard layout.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dashboard_layoutCreateDashboardLayoutRequest",
"required_fields": [
"dashboard_id",
"layout_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dashboard_layoutCreateDashboardLayoutRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  dashboard_id: value\n  layout_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"dashboard_id\": \"value\",\n    \"layout_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"dashboard_id": "value",
"layout_name": "value"
}
},
"requiredFields": [
"dashboard_id",
"layout_name"
],
"description": "Minimum configuration for dashboard_layoutCreateDashboardLayoutRequest"
},
"fieldMetadata": {
"dashboard_id": {
"type": "string",
"description": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "Description describes the dashboard layout.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_selected": {
"type": "boolean",
"description": "IsSelected indicates whether the current layout is the default selected by the user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_shared": {
"type": "boolean",
"description": "IsShared is a boolean flag when set to true users in the tenant can utilize the same dashboard layout.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_data": {
"type": "object",
"description": "LayoutData holds the layout structure encoded as a JSON.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_name": {
"type": "string",
"description": "LayoutName is the name of the dashboard layout.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "delete_custom_dashboards_layout",
"description": "DELETE Dashboard Layout.",
"method": "DELETE",
"path": "/api/web/custom/namespaces/system/dashboards/{dashboard_id}/layouts/{layout_name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "layout_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object"
}
},
{
"name": "get_custom_dashboards_layout",
"description": "GET Dashboard Layout.",
"method": "GET",
"path": "/api/web/custom/namespaces/system/dashboards/{dashboard_id}/layouts/{layout_name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "layout_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_custom_dashboards_layout",
"description": "Update Dashboard Layout.",
"method": "PUT",
"path": "/api/web/custom/namespaces/system/dashboards/{dashboard_id}/layouts/{layout_name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "dashboard_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "layout_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "UpdateDashboardLayoutRequest contains details to update a dashboard layout.",
"title": "UpdateDashboardLayoutRequest",
"x-displayname": "UpdateDashboardLayoutRequestt.",
"x-ves-proto-message": "ves.io.schema.ui.dashboard_layout.UpdateDashboardLayoutRequest",
"properties": {
"dashboard_id": {
"type": "string",
"description": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"title": "DashboardId",
"x-displayname": "DashboardId.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"x-f5xc-description-medium": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"description": {
"type": "string",
"description": "Description describes the dashboard layout.",
"title": "Description",
"x-displayname": "Description.",
"x-f5xc-description-short": "Description describes the dashboard layout.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"is_selected": {
"type": "boolean",
"description": "IsSelected indicates whether the current layout is the default selected by the user.",
"title": "IsSelected",
"format": "boolean",
"x-displayname": "IsSelected.",
"x-f5xc-description-short": "IsSelected indicates whether the current layout is the default selected by the user.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_shared": {
"type": "boolean",
"description": "IsShared is true if the layout is shared.",
"title": "IsShared",
"format": "boolean",
"x-displayname": "IsShared",
"x-f5xc-description-short": "IsShared is true if the layout is shared.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_data": {
"type": "object",
"description": "LayoutData holds the layout structure encoded as a JSON.",
"title": "LayoutData",
"x-displayname": "LayoutData.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "LayoutData holds the layout structure encoded as a JSON.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_name": {
"type": "string",
"description": "LayoutName is the name of the dashboard layout.",
"title": "LayoutName",
"minLength": 1,
"maxLength": 256,
"x-displayname": "LayoutName.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "LayoutName is the name of the dashboard layout.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"new_layout_name": {
"type": "string",
"description": "NewLayoutName is the new name of the dashboard layout.",
"title": "NewLayoutName",
"x-displayname": "NewLayoutName.",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "NewLayoutName is the new name of the dashboard layout.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "UpdateDashboardLayoutRequest contains details to update a dashboard layout.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dashboard_layoutUpdateDashboardLayoutRequest",
"required_fields": [
"dashboard_id",
"layout_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dashboard_layoutUpdateDashboardLayoutRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  dashboard_id: value\n  layout_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"dashboard_id\": \"value\",\n    \"layout_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"dashboard_id": "value",
"layout_name": "value"
}
},
"requiredFields": [
"dashboard_id",
"layout_name"
],
"description": "Minimum configuration for dashboard_layoutUpdateDashboardLayoutRequest"
},
"fieldMetadata": {
"dashboard_id": {
"type": "string",
"description": "DashboardId is the unique ID for each dashboard types, the preset unique ID is defined in stellar code.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "Description describes the dashboard layout.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_selected": {
"type": "boolean",
"description": "IsSelected indicates whether the current layout is the default selected by the user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_shared": {
"type": "boolean",
"description": "IsShared is true if the layout is shared.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_data": {
"type": "object",
"description": "LayoutData holds the layout structure encoded as a JSON.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"layout_name": {
"type": "string",
"description": "LayoutName is the name of the dashboard layout.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"new_layout_name": {
"type": "string",
"description": "NewLayoutName is the new name of the dashboard layout.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-delete": {
"name": "custom-delete",
"displayName": "Custom Delete",
"operations": [
{
"name": "create_custom_delete",
"description": "DELETE",
"method": "POST",
"path": "/api/web/custom/namespaces/{namespace}/oidc_provider/{name}/delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "DeleteRequest is the request payload for deleting an OIDC provider/SSO configuration.",
"title": "Delete Request",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.oidc_provider.DeleteRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of OIDC provider object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Supports only system namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "DeleteRequest is the request payload for deleting an OIDC provider/SSO configuration.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schemaoidc_providerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schemaoidc_providerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schemaoidc_providerDeleteRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of OIDC provider object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Supports only system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-idm-user-sync": {
"name": "custom-idm-user-sync",
"displayName": "Custom Idm User Sync",
"operations": [
{
"name": "create_custom_idm_user_sync",
"description": "Sync user",
"method": "POST",
"path": "/api/web/custom/idm/user/sync",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Empty is a message without actual content/body.",
"title": "Empty",
"x-displayname": "Empty",
"x-ves-proto-message": "ves.io.schema.user.Empty",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schemauserEmpty",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schemauserEmpty\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schemauserEmpty"
}
}
]
},
	"custom-list": {
"name": "custom-list",
"displayName": "Custom List",
"operations": [
{
"name": "list_custom_list",
"description": "List Subscriptions.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/subscriptions/custom_list",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "current",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"subscriptions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "subscriptions",
"type": "array",
"description": "IP address configuration"
}
]
}
]
},
	"custom-mappers": {
"name": "custom-mappers",
"displayName": "Custom Mappers",
"operations": [
{
"name": "list_custom_mappers",
"description": "GET OIDC mappers.",
"method": "GET",
"path": "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "email",
"type": "string",
"description": "Set authentication token field name to be used by F5XC for identifying user's email.\nPlease ensure the field name using here is set as part of authentication token from corresponding\nprovider's authentication application."
      }
]
},
{
"name": "create_custom_mapper",
"description": "Update OIDC mappers.",
"method": "POST",
"path": "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right\nattributes for user object. Use this mapper to map values from authentication token to user attributes.",
      "title": "UpdateOIDCMappersRequest",
"x-displayname": "UpdateOIDCMappersRequest.",
"x-ves-proto-message": "ves.io.schema.oidc_provider.UpdateOIDCMappersRequest",
"properties": {
"name": {
"type": "string",
"description": "Name contains name/alias of underlying OIDC provider.",
"title": "OIDC provider name",
"x-displayname": "OIDC provider name.",
"x-ves-example": "[OIDC, google, Azure-OIDC]",
"x-f5xc-example": "[oidc, google, azure-oidc]",
"x-f5xc-description-short": "Name contains name/alias of underlying OIDC provider.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace contains namespace of OIDC provider. Namespace should be system.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "Namespace contains namespace of OIDC provider. Namespace should be system.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"oidc_mappers": {
"allOf": [
{
"$ref": "#/components/schemas/oidc_providerOIDCMappers"
}
],
"x-f5xc-description-short": "Configuration parameter for oidc mappers.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right attributes for user object.",
"x-f5xc-description-medium": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right attributes for user object. Use this mapper to map values from authentication token to user attributes.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for oidc_providerUpdateOIDCMappersRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for oidc_providerUpdateOIDCMappersRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for oidc_providerUpdateOIDCMappersRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name contains name/alias of underlying OIDC provider.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace contains namespace of OIDC provider. Namespace should be system.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"oidc_mappers": {
"type": "object",
"description": "When 3rd party OIDC provider uses non-standard field names, user creation in F5XC Identity may fail to identify right\nattributes for user object. Use this mapper to map values from authentication token to user attributes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"oidc_mappers.email": {
"type": "string",
"description": "Set authentication token field name to be used by F5XC for identifying user's email.\nPlease ensure the field name using here is set as part of authentication token from corresponding\nprovider's authentication application.",
      "constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"custom-password-admin-reset": {
"name": "custom-password-admin-reset",
      "displayName": "Custom Password Admin Reset",
      "operations": [
{
"name": "create_custom_password_admin_reset",
      "description": "Reset password by admin.",
      "method": "POST",
"path": "/api/web/custom/password/admin_reset",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Reset password by admin request contains email of user for which password will be reset.",
      "title": "Reset password by admin request",
      "x-displayname": "Reset password by admin request.",
      "x-ves-proto-message": "ves.io.schema.user.ResetPasswordByAdminRequest",
      "properties": {
"email": {
"type": "string",
"description": "Email of user for which password will be reset.",
      "title": "Email",
"x-displayname": "Email",
"x-ves-example": "John@example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "john@example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Email of user for which password will be reset.",
      "format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Reset password by admin request contains email of user for which password will be reset.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for userResetPasswordByAdminRequest",
      "required_fields": [
"email"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for userResetPasswordByAdminRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  email: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"email\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"email": "value"
}
},
"requiredFields": [
"email"
],
"description": "Minimum configuration for userResetPasswordByAdminRequest"
      },
"fieldMetadata": {
"email": {
"type": "string",
"description": "Email of user for which password will be reset.",
      "constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"custom-password-reset": {
"name": "custom-password-reset",
      "displayName": "Custom Password Reset",
      "operations": [
{
"name": "create_custom_password_reset",
      "description": "Reset password.",
      "method": "POST",
"path": "/api/web/custom/password/reset",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Empty is a message without actual content/body.",
"title": "Empty",
"x-displayname": "Empty",
"x-ves-proto-message": "ves.io.schema.user.Empty",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schemauserEmpty",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schemauserEmpty\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schemauserEmpty"
}
}
]
},
	"custom-scim": {
"name": "custom-scim",
"displayName": "Custom Scim",
"operations": [
{
"name": "replace_custom_scim",
"description": "Update OIDC provider SCIM Integration.",
"method": "PUT",
"path": "/api/web/custom/namespaces/{namespace}/oidc_providers/{name}/scim",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for updating the SCIM integration status for an OIDC provider.",
"title": "UpdateScimIntegrationRequest",
"x-displayname": "Update SCIM Integration Request.",
"x-ves-proto-message": "ves.io.schema.oidc_provider.UpdateScimIntegrationRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of OIDC provider object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Supports only system namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scim_enabled": {
"type": "boolean",
"description": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.",
"title": "scim_enabled",
"format": "boolean",
"x-displayname": "SCIM enabled.",
"x-f5xc-description-short": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.",
"x-f5xc-description-medium": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scim_token_meta": {
      "allOf": [
{
"$ref": "#/components/schemas/api_credentialRecreateScimTokenRequest"
      }
],
"x-f5xc-description-short": "Configuration parameter for scim token meta.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for updating the SCIM integration status for an OIDC provider.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for oidc_providerUpdateScimIntegrationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for oidc_providerUpdateScimIntegrationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"scim_enabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for oidc_providerUpdateScimIntegrationRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of OIDC provider object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Supports only system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scim_enabled": {
"type": "boolean",
"description": "Update the SCIM integration, either enables/disables for the OIDC provider on the basis of the provided value.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scim_token_meta": {
      "type": "object",
"description": "RecreateScimTokenRequest is the request format for generating SCIM API credential.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scim_token_meta.expiration_days": {
      "type": "integer",
"description": "Qty of days of service credential expiration. Default value is 180.\nExpiration days value can range between 1 and 730.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 730,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"scim_token_meta.namespace": {
      "type": "string",
"description": "Value of namespace is always \"system\".",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "scim_enabled",
"type": "boolean",
"description": "This is for representing the status of scim integration."
},
{
"field": "scim_token",
      "type": "object",
"description": ""
},
{
"field": "url",
"type": "string",
"description": "This is the root URL that needs to be used in the external identity providers SCIM client which will be used for all API requests.\nAs an example, if root URL is https://customer.domain/API/scim/namespaces/system/v2/ actual API request client will need make for user resource is via endpoint https://customer.domain/API/scim/namespaces/system/v2/Users."
      }
]
}
]
},
	"custom-user-groups": {
"name": "custom-user-groups",
"displayName": "Custom User Groups",
"operations": [
{
"name": "list_custom_user_groups",
"description": "GET all User Groups for the tenant.",
"method": "GET",
"path": "/api/web/custom/namespaces/system/user_groups",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"user_groups": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "user_groups",
"type": "array",
"description": "List of the user groups."
}
]
},
{
"name": "create_custom_user_group",
"description": "Create User Group.",
"method": "POST",
"path": "/api/web/custom/namespaces/system/user_groups",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to create/update user group with user assignment to it.",
"title": "User Group Request",
"x-displayname": "Create/Replace User Group With Users.",
"x-ves-proto-message": "ves.io.schema.user_group.UserGroupRequest",
"properties": {
"description": {
"type": "string",
"description": "The description set for this user_group.",
"title": "description",
"x-displayname": "Description.",
"x-ves-example": "User group - Group1.",
"x-f5xc-example": "User group - Group1",
"x-f5xc-description-short": "The description set for this user_group.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"display_name": {
"type": "string",
"description": "Display name of the group used as well for scim sync.",
"title": "Display Name",
"x-displayname": "Display Name.",
"x-ves-example": "Sales",
"x-f5xc-example": "Sales",
"x-f5xc-description-short": "Display name of the group used as well for scim sync.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Internal name of the group.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Sales",
"x-f5xc-example": "sales",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace_roles": {
"type": "array",
"description": "List of roles that the user group has for each namespace.",
"title": "Namespace roles",
"items": {
"$ref": "#/components/schemas/schemaNamespaceRoleType"
},
"x-displayname": "Namespace Roles.",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "List of roles that the user group has for each namespace.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sync_id": {
"type": "string",
"description": "Sync ID of the user group.",
"title": "Sync Id",
"x-displayname": "Sync ID",
"x-ves-example": "External-sync-ID-anfjadh.",
"x-f5xc-example": "external-sync-id-anfjadh",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"usernames": {
"type": "array",
"description": "List of the users enumerated by name.",
"title": "Usernames",
"items": {
"type": "string"
},
"x-displayname": "Usernames",
"x-ves-example": "[\"dana@example.com\", \"dana@example.com\"]",
"x-f5xc-example": "\"[\"dana@example.com\", \"dana@example.com\"]\"",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to create/update user group with user assignment to it.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for user_groupUserGroupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for user_groupUserGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace_roles": {
"type": "array"
},
"references_count": {
"type": "object"
},
"sync_id": {
"type": "string"
},
"uid": {
"type": "string"
},
"usernames": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for user_groupUserGroupRequest"
},
"fieldMetadata": {
"description": {
"type": "string",
"description": "The description set for this user_group.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"display_name": {
"type": "string",
"description": "Display name of the group used as well for scim sync.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Internal name of the group.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_roles": {
"type": "array",
"description": "List of roles that the user group has for each namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sync_id": {
"type": "string",
"description": "Sync ID of the user group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"usernames": {
"type": "array",
"description": "List of the users enumerated by name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "description",
"type": "string",
"description": "The description set for this user_group."
},
{
"field": "display_name",
"type": "string",
"description": "Display name of the group used as well for scim sync."
},
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "Internal ID of the group."
},
{
"field": "name",
"type": "string",
"description": "Internal name of the group."
},
{
"field": "namespace_roles",
"type": "array",
"description": "List of namespace,roles for the user group."
},
{
"field": "references_count",
"type": "object",
"description": "The map holds the count of references which needs to be shown in the group list."
},
{
"field": "sync_id",
"type": "string",
"description": "Sync ID of the user group."
},
{
"field": "sync_mode",
"type": "object",
"description": ""
},
{
"field": "uid",
"type": "string",
"description": "Internal uid of the group."
},
{
"field": "usernames",
"type": "array",
"description": "List of the users in the group."
}
]
},
{
"name": "delete_custom_user_group",
"description": "DELETE a group provided the group ID.",
"method": "DELETE",
"path": "/api/web/custom/namespaces/system/user_groups/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "attempt_remove_references",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object"
}
},
{
"name": "get_custom_user_group",
"description": "Fetch all the details for a group provided the group ID.",
"method": "GET",
"path": "/api/web/custom/namespaces/system/user_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace_roles": {
"type": "array"
},
"references_count": {
"type": "object"
},
"sync_id": {
"type": "string"
},
"uid": {
"type": "string"
},
"usernames": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "description",
"type": "string",
"description": "The description set for this user_group."
},
{
"field": "display_name",
"type": "string",
"description": "Display name of the group used as well for scim sync."
},
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "Internal ID of the group."
},
{
"field": "name",
"type": "string",
"description": "Internal name of the group."
},
{
"field": "namespace_roles",
"type": "array",
"description": "List of namespace,roles for the user group."
},
{
"field": "references_count",
"type": "object",
"description": "The map holds the count of references which needs to be shown in the group list."
},
{
"field": "sync_id",
"type": "string",
"description": "Sync ID of the user group."
},
{
"field": "sync_mode",
"type": "object",
"description": ""
},
{
"field": "uid",
"type": "string",
"description": "Internal uid of the group."
},
{
"field": "usernames",
"type": "array",
"description": "List of the users in the group."
}
]
},
{
"name": "replace_custom_user_group",
"description": "Replace the User Group fields / accesses / associations.",
      "method": "PUT",
"path": "/api/web/custom/namespaces/system/user_groups/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to create/update user group with user assignment to it.",
"title": "User Group Request",
"x-displayname": "Create/Replace User Group With Users.",
"x-ves-proto-message": "ves.io.schema.user_group.UserGroupRequest",
"properties": {
"description": {
"type": "string",
"description": "The description set for this user_group.",
"title": "description",
"x-displayname": "Description.",
"x-ves-example": "User group - Group1.",
"x-f5xc-example": "User group - Group1",
"x-f5xc-description-short": "The description set for this user_group.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"display_name": {
"type": "string",
"description": "Display name of the group used as well for scim sync.",
"title": "Display Name",
"x-displayname": "Display Name.",
"x-ves-example": "Sales",
"x-f5xc-example": "Sales",
"x-f5xc-description-short": "Display name of the group used as well for scim sync.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Internal name of the group.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Sales",
"x-f5xc-example": "sales",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace_roles": {
"type": "array",
"description": "List of roles that the user group has for each namespace.",
"title": "Namespace roles",
"items": {
"$ref": "#/components/schemas/schemaNamespaceRoleType"
},
"x-displayname": "Namespace Roles.",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "List of roles that the user group has for each namespace.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sync_id": {
"type": "string",
"description": "Sync ID of the user group.",
"title": "Sync Id",
"x-displayname": "Sync ID",
"x-ves-example": "External-sync-ID-anfjadh.",
"x-f5xc-example": "external-sync-id-anfjadh",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"usernames": {
"type": "array",
"description": "List of the users enumerated by name.",
"title": "Usernames",
"items": {
"type": "string"
},
"x-displayname": "Usernames",
"x-ves-example": "[\"dana@example.com\", \"dana@example.com\"]",
"x-f5xc-example": "\"[\"dana@example.com\", \"dana@example.com\"]\"",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to create/update user group with user assignment to it.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for user_groupUserGroupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for user_groupUserGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace_roles": {
"type": "array"
},
"references_count": {
"type": "object"
},
"sync_id": {
"type": "string"
},
"uid": {
"type": "string"
},
"usernames": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for user_groupUserGroupRequest"
},
"fieldMetadata": {
"description": {
"type": "string",
"description": "The description set for this user_group.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"display_name": {
"type": "string",
"description": "Display name of the group used as well for scim sync.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Internal name of the group.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_roles": {
"type": "array",
"description": "List of roles that the user group has for each namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sync_id": {
"type": "string",
"description": "Sync ID of the user group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"usernames": {
"type": "array",
"description": "List of the users enumerated by name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "description",
"type": "string",
"description": "The description set for this user_group."
},
{
"field": "display_name",
"type": "string",
"description": "Display name of the group used as well for scim sync."
},
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "Internal ID of the group."
},
{
"field": "name",
"type": "string",
"description": "Internal name of the group."
},
{
"field": "namespace_roles",
"type": "array",
"description": "List of namespace,roles for the user group."
},
{
"field": "references_count",
"type": "object",
"description": "The map holds the count of references which needs to be shown in the group list."
},
{
"field": "sync_id",
"type": "string",
"description": "Sync ID of the user group."
},
{
"field": "sync_mode",
"type": "object",
"description": ""
},
{
"field": "uid",
"type": "string",
"description": "Internal uid of the group."
},
{
"field": "usernames",
"type": "array",
"description": "List of the users in the group."
}
]
}
]
},
	"custom-user-groups-analyze-for-deletion": {
"name": "custom-user-groups-analyze-for-deletion",
"displayName": "Custom User Groups Analyze For Deletion",
"operations": [
{
"name": "create_custom_user_groups_analyze_for_deletion",
"description": "Analyze For Deletion.",
"method": "POST",
"path": "/api/web/custom/namespaces/system/user_groups/analyze_for_deletion",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Analyze For Deletion Request.\n\nAnalyzeForDeletionRequest is for the checking whether the object is deletable by going through it's references in other objects.",
"x-displayname": "AnalyzeForDeletionRequest.",
"x-ves-oneof-field-object_identifier": "[\"namespace_name_identifier\",\"object_uid\"]",
"x-ves-proto-message": "ves.io.schema.user_group.AnalyzeForDeletionRequest",
"properties": {
"namespace_name_identifier": {
"allOf": [
{
"$ref": "#/components/schemas/user_groupNamespaceNameIdentifier"
}
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"object_uid": {
"type": "string",
"description": "Exclusive with [namespace_name_identifier]\nUid of the specific object.",
"title": "Uid of the object",
"x-displayname": "Uid",
"x-ves-example": "00000000-0000-4000-8000-399945a7d658.",
"x-f5xc-example": "00000000-0000-4000-8000-399945a7d658",
"x-f5xc-description-short": "Exclusive with [namespace_name_identifier] Uid of the specific object.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-medium": "Analyze For Deletion Request. AnalyzeForDeletionRequest is for the checking whether the object is deletable by going through it's references in other objects.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for user_groupAnalyzeForDeletionRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for user_groupAnalyzeForDeletionRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"back_referencing_items": {
"type": "object"
},
"referenced_items": {
"type": "object"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for user_groupAnalyzeForDeletionRequest"
},
"fieldMetadata": {
"namespace_name_identifier": {
"type": "object",
"description": "NamespaceNameIdentifier holds the name and namespace of the specific object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_name_identifier.object_name": {
"type": "string",
"description": "Name of the specific object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_name_identifier.object_namespace": {
"type": "string",
"description": "Namespace of the specific object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"object_uid": {
"type": "string",
"description": "Exclusive with [namespace_name_identifier]\nUid of the specific object.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"object_identifier": [
"namespace_name_identifier",
"object_uid"
]
},
"responseSummary": [
{
"field": "back_referencing_items",
"type": "object",
"description": "BackReferencingItems holds the details of the objects which are referencing the deletion candidate."
},
{
"field": "deletion_analysis",
"type": "object",
"description": ""
},
{
"field": "referenced_items",
"type": "object",
"description": "ReferencedItems holds the details of the objects which are referenced in the deletion candidate."
}
]
}
]
},
	"custom-user-groups-assign-namespace-roles": {
"name": "custom-user-groups-assign-namespace-roles",
"displayName": "Custom User Groups Assign Namespace Roles",
"operations": [
{
"name": "replace_custom_user_groups_assign_namespace_role",
"description": "Assign role to User Group.",
"method": "PUT",
"path": "/api/web/custom/namespaces/system/user_groups/{name}/assign_namespace_roles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Roles of the specific group to be modified.",
"title": "Modify roles of the user group",
"x-displayname": "Modify Role Request.",
"x-ves-proto-message": "ves.io.schema.user_group.ModifyRoleRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the specific group.",
"title": "Name of the user group",
"x-displayname": "Name",
"x-ves-example": "00000000-0000-4000-8000-6a2fe61e3db8.",
"x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace_roles": {
"type": "array",
"description": "Roles of the specific group to be modified.",
"title": "Namespace Roles",
"items": {
"$ref": "#/components/schemas/schemaNamespaceRoleType"
},
"x-displayname": "Namespace Roles.",
"x-ves-example": "[{NamespaceRoleType: ...}]",
"x-f5xc-example": "[{NamespaceRoleType...}]",
"x-f5xc-description-short": "Roles of the specific group to be modified.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Roles of the specific group to be modified.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for user_groupModifyRoleRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for user_groupModifyRoleRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace_roles": {
"type": "array"
},
"references_count": {
"type": "object"
},
"sync_id": {
"type": "string"
},
"uid": {
"type": "string"
},
"usernames": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for user_groupModifyRoleRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the specific group.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_roles": {
"type": "array",
"description": "Roles of the specific group to be modified.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "description",
"type": "string",
"description": "The description set for this user_group."
},
{
"field": "display_name",
"type": "string",
"description": "Display name of the group used as well for scim sync."
},
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "Internal ID of the group."
},
{
"field": "name",
"type": "string",
"description": "Internal name of the group."
},
{
"field": "namespace_roles",
"type": "array",
"description": "List of namespace,roles for the user group."
},
{
"field": "references_count",
"type": "object",
"description": "The map holds the count of references which needs to be shown in the group list."
},
{
"field": "sync_id",
"type": "string",
"description": "Sync ID of the user group."
},
{
"field": "sync_mode",
"type": "object",
"description": ""
},
{
"field": "uid",
"type": "string",
"description": "Internal uid of the group."
},
{
"field": "usernames",
"type": "array",
"description": "List of the users in the group."
}
]
}
]
},
	"custom-user-groups-remove-namespace-roles": {
"name": "custom-user-groups-remove-namespace-roles",
"displayName": "Custom User Groups Remove Namespace Roles",
"operations": [
{
"name": "replace_custom_user_groups_remove_namespace_role",
"description": "Remove role from User Group.",
"method": "PUT",
"path": "/api/web/custom/namespaces/system/user_groups/{name}/remove_namespace_roles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Roles of the specific group to be modified.",
"title": "Modify roles of the user group",
"x-displayname": "Modify Role Request.",
"x-ves-proto-message": "ves.io.schema.user_group.ModifyRoleRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the specific group.",
"title": "Name of the user group",
"x-displayname": "Name",
"x-ves-example": "00000000-0000-4000-8000-6a2fe61e3db8.",
"x-f5xc-example": "00000000-0000-4000-8000-6a2fe61e3db8",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace_roles": {
"type": "array",
"description": "Roles of the specific group to be modified.",
"title": "Namespace Roles",
"items": {
"$ref": "#/components/schemas/schemaNamespaceRoleType"
},
"x-displayname": "Namespace Roles.",
"x-ves-example": "[{NamespaceRoleType: ...}]",
"x-f5xc-example": "[{NamespaceRoleType...}]",
"x-f5xc-description-short": "Roles of the specific group to be modified.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Roles of the specific group to be modified.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for user_groupModifyRoleRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for user_groupModifyRoleRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace_roles": {
"type": "array"
},
"references_count": {
"type": "object"
},
"sync_id": {
"type": "string"
},
"uid": {
"type": "string"
},
"usernames": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for user_groupModifyRoleRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the specific group.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_roles": {
"type": "array",
"description": "Roles of the specific group to be modified.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "description",
"type": "string",
"description": "The description set for this user_group."
},
{
"field": "display_name",
"type": "string",
"description": "Display name of the group used as well for scim sync."
},
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "Internal ID of the group."
},
{
"field": "name",
"type": "string",
"description": "Internal name of the group."
},
{
"field": "namespace_roles",
"type": "array",
"description": "List of namespace,roles for the user group."
},
{
"field": "references_count",
"type": "object",
"description": "The map holds the count of references which needs to be shown in the group list."
},
{
"field": "sync_id",
"type": "string",
"description": "Sync ID of the user group."
},
{
"field": "sync_mode",
"type": "object",
"description": ""
},
{
"field": "uid",
"type": "string",
"description": "Internal uid of the group."
},
{
"field": "usernames",
"type": "array",
"description": "List of the users in the group."
}
]
}
]
},
	"custom-users-group-add": {
"name": "custom-users-group-add",
"displayName": "Custom Users Group Add",
"operations": [
{
"name": "replace_custom_users_group_add",
"description": "Add user to groups.",
"method": "PUT",
"path": "/api/web/custom/namespaces/system/users/group_add",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Used for adding or removing specific user to/from group.",
"title": "User group request",
"x-displayname": "User group request.",
"x-ves-proto-message": "ves.io.schema.user.UserGroupRequest",
"properties": {
"group_names": {
"type": "array",
"description": "Group list must be associated to this user.",
"title": "Groups",
"items": {
"type": "string"
},
"x-displayname": "Groups",
"x-ves-example": "[\"dev-group-1\"]",
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
"x-f5xc-description-short": "Group list must be associated to this user.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"username": {
"type": "string",
"description": "Username of the user who should be associated with the group.",
"title": "Username",
"minLength": 1,
"maxLength": 320,
"x-displayname": "Username",
"x-ves-example": "Dana@example.com.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_bytes": "320",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-example": "dana@example.com",
"x-validation-rules": {
"ves.io.schema.rules.string.max_bytes": "320",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-description-short": "Username of the user who should be associated with the group.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 320,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 320,
"min": 1
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Used for adding or removing specific user to/from group.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for userUserGroupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for userUserGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for userUserGroupRequest"
},
"fieldMetadata": {
"group_names": {
"type": "array",
"description": "Group list must be associated to this user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"username": {
"type": "string",
"description": "Username of the user who should be associated with the group.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 320,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 320,
"min": 1
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "error",
"type": "object",
"description": ""
}
]
}
]
},
	"custom-users-group-remove": {
"name": "custom-users-group-remove",
"displayName": "Custom Users Group Remove",
"operations": [
{
"name": "replace_custom_users_group_remove",
"description": "Remove user from groups.",
"method": "PUT",
"path": "/api/web/custom/namespaces/system/users/group_remove",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Used for adding or removing specific user to/from group.",
"title": "User group request",
"x-displayname": "User group request.",
"x-ves-proto-message": "ves.io.schema.user.UserGroupRequest",
"properties": {
"group_names": {
"type": "array",
"description": "Group list must be associated to this user.",
"title": "Groups",
"items": {
"type": "string"
},
"x-displayname": "Groups",
"x-ves-example": "[\"dev-group-1\"]",
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
"x-f5xc-description-short": "Group list must be associated to this user.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"username": {
"type": "string",
"description": "Username of the user who should be associated with the group.",
"title": "Username",
"minLength": 1,
"maxLength": 320,
"x-displayname": "Username",
"x-ves-example": "Dana@example.com.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_bytes": "320",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-example": "dana@example.com",
"x-validation-rules": {
"ves.io.schema.rules.string.max_bytes": "320",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-description-short": "Username of the user who should be associated with the group.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 320,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 320,
"min": 1
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Used for adding or removing specific user to/from group.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for userUserGroupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for userUserGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for userUserGroupRequest"
},
"fieldMetadata": {
"group_names": {
"type": "array",
"description": "Group list must be associated to this user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"username": {
"type": "string",
"description": "Username of the user who should be associated with the group.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 320,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 320,
"min": 1
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "error",
"type": "object",
"description": ""
}
]
}
]
},
	"customer-data": {
"name": "customer-data",
"displayName": "Customer Data",
"operations": [
{
"name": "list_customer_data",
"description": "GET customer data.",
"method": "GET",
"path": "/api/web/namespaces/system/customer_data",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"customer_notes": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "customer_notes",
"type": "string",
"description": "Public instructions or handling notes meant for customers."
}
]
},
{
"name": "replace_customer_data",
"description": "Update customer data.",
"method": "PUT",
"path": "/api/web/namespaces/system/customer_data",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "X-example: { \"customer_notes\": \"Follow Tier 1 support guidelines, escalate after 30 minutes.\" }\nRequest message for updating customer-facing RTIP instructions and labels.",
"title": "UpdateCustomerDataRequest",
"x-displayname": "Update Customer Data Request.",
"x-ves-proto-message": "ves.io.schema.rtip.UpdateCustomerDataRequest",
"properties": {
"customer_notes": {
"type": "string",
"description": "Public instructions or handling notes meant for customers.",
"title": "Customer Notes",
"minLength": 1,
"maxLength": 10000,
"x-displayname": "Customer Notes.",
"x-ves-example": "Follow Tier 1 support guidelines and escalate after 30 minutes.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "10000",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "^\\\\S.*\\\\S$|^\\\\S$"
},
"x-f5xc-example": "Follow Tier 1 support guidelines and escalate after 30 minutes.",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "10000",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "^\\\\S.*\\\\S$|^\\\\S$"
},
"x-f5xc-description-short": "Public instructions or handling notes meant for customers.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 10000,
"pattern": "^\\\\S.*\\\\S$|^\\\\S$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rtipUpdateCustomerDataRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rtipUpdateCustomerDataRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for rtipUpdateCustomerDataRequest"
},
"fieldMetadata": {
"customer_notes": {
"type": "string",
"description": "Public instructions or handling notes meant for customers.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 10000,
"pattern": "^\\\\S.*\\\\S$|^\\\\S$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"customer-support-comment-attachment": {
"name": "customer-support-comment-attachment",
"displayName": "Customer Support Comment Attachment",
"operations": [
{
"name": "get_customer_support_comment_attachment",
"description": "GET attachment.",
"method": "GET",
"path": "/api/web/namespaces/system/customer_support/{name}/comment/{comment_id}/attachment/{attachment_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "comment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "attachment_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"customer-support-tax-exempt-request": {
"name": "customer-support-tax-exempt-request",
"displayName": "Customer Support Tax Exempt Request",
"operations": [
{
"name": "create_customer_support_tax_exempt_request",
"description": "Tax exemption verification request.",
"method": "POST",
"path": "/api/web/namespaces/system/customer_support/tax_exempt_request",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S. Only)",
"title": "Request to verify customer tax exemption status",
"x-displayname": "Request to verify customer tax exemption status.",
"x-ves-proto-message": "ves.io.schema.customer_support.RaiseTaxExemptVerificationSupportTicketRequest",
"properties": {
"attachments": {
"type": "array",
"description": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
"title": "Attachments information",
"items": {
"$ref": "#/components/schemas/customer_supportAttachmentType"
},
"x-displayname": "Attachments details.",
"x-f5xc-description-short": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
"x-f5xc-description-medium": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_description": {
"type": "string",
"description": "Description introducing reasons for tax exemption status verification.",
"title": "Request description",
"x-displayname": "Description.",
"x-ves-example": "Requesting a tax exemption status review as we'RE a not-for-profit organisation.",
"x-f5xc-example": "requesting a tax exemption status review as we're a not-for-profit organisation",
"x-f5xc-description-short": "Description introducing reasons for tax exemption status verification.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S.",
"x-f5xc-description-medium": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S. Only).",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportRaiseTaxExemptVerificationSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportRaiseTaxExemptVerificationSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportRaiseTaxExemptVerificationSupportTicketRequest"
},
"fieldMetadata": {
"attachments": {
"type": "array",
"description": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_description": {
"type": "string",
"description": "Description introducing reasons for tax exemption status verification.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "X-displayName : \"Name\"\nname of the ticket created on the back of the request."
}
]
}
]
},
	"customer-supports": {
"name": "customer-supports",
"displayName": "Customer Supports",
"operations": [
{
"name": "create_customer_support",
"description": "Create Customer Support.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/customer_supports",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of customer_support",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.customer_support.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/schemacustomer_supportCreateSpecType__ves_io_schema_customer_support"
}
],
"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 customer_supportCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new customer support ticket in our customer support provider system.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.category": {
"type": "string",
"description": "Ticket area further narrows down the ticket - infrastructure, application,\ndashboards can be examples.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.comments": {
"type": "array",
"description": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.description": {
"type": "string",
"description": "Customer's description of the issue (free text)",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ongoing": {
"type": "boolean",
"description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.priority": {
"type": "string",
"description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRIORITY_UNKNOWN"
},
"spec.product_data": {
"type": "string",
"description": "Product data is a free text field that can be used to describe the issue in more detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.relates_to": {
"type": "array",
"description": "Optional reference to any original ticket in case the ticket being created is a followup.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service": {
"type": "string",
"description": "Indicates the list of support service\n\nUnknown Support Service\nAccount Protection Support Service\nAdministration Support Service\nApplication Traffic Insight Support Service\nAudit Logs & Alerts Support Service\nAuthentication Intelligence Support Service\nBilling Support Service\nClient Side Defense Support Service\nCloud & Edge Sites Support Service\ndeprecated: use SS_MULTI_CLOUD_NETWORK_CONNECT instead\nDDoS & Transit Support Service\nDeprecated: use SS_ROUTED_DDOS instead\nDistributed Apps Support Service\nDNS Management Support Service\nLoadBalancers Support Service\ndeprecated: use SS_MULTI_CLOUD_APP_CONNECT instead\nShared Configuration Support Service\nWeb App & API Protection Support Service\nOther Support Service\nBot Defense Support Service\nContent delivery network Support Service\nObservability Support Service\nDelegated Access Support Service\nNetworking & security across clouds, edge and on-premises\nConnect apps across clouds, edge and on-premises using Load Balancers\nData Intelligence Support Service\nNGINX One Support Service\nWeb App Scanning Support Service\nRouted DDoS Support Service\nMobile App Shield protects mobile apps from reverse engineering, tampering and malware\nDefault for deprecated services\nAutomation Support Service for Terraform Provider.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SS_UNKNOWN"
},
"spec.status": {
"type": "string",
"description": "State of the ticket so the customers know if the problem is being looked into\n\nUnknown or empty support ticket status\nIndicates a new ticket, waiting to be assigned to an agent\nIndicates an open issues, actively being looked into\nIndicates a pending issue, an open issue not actively being looked into\nIndicates on issue that on-hold, waiting for more information\nIndicates a solved issue, waiting for customer's confirmation\nIndicates a closed issue, resolved and customer approved\nIndicates a failed ticket, a failed ticket didn't make it into Salesforce and a customer should create new one instead.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "STATUS_UNKNOWN"
},
"spec.subject": {
"type": "string",
"description": "Subject of the ticket.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timeline": {
"type": "string",
"description": "Timeline is a free text field that can be used to describe the issue in more detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timezone": {
"type": "string",
"description": "Stores the timezone provided by the user at the time of support ticket creation.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z_]+/[A-Z][a-zA-Z_]+$",
"formatDescription": "IANA timezone database (e.g., America/New_York)",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.topic": {
"type": "string",
"description": "Support Topic indicates the list of topics for service tickets\n\nUnknown/empty priority\nACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST\nACCOUNT_SUPPORT_TOPIC_ACCOUNT\nACCOUNT_SUPPORT_TOPIC_BILLING\nACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE\nACCOUNT_SUPPORT_TOPIC_PUBLIC_IP\nACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE\nACCOUNT_SUPPORT_TOPIC_RMA\nACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION\nACCOUNT_SUPPORT_TOPIC_OTHERS\nTECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES\nTECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE\nTECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION\nTECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION\nTECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING\nTECHNICAL_SUPPORT_TOPIC_OTHERS\nINCIDENT_SUPPORT_TOPIC_LATENCY\nINCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION\nINCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE\nINCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE\nINCIDENT_SUPPORT_TOPIC_OTHERS\nTASK_TOPIC_PLAN_TRANSITION\nPROBLEM_TOPIC_SUPPORT_ALERT\nQUESTION_TOPIC_INFRASTRUCTURE\nTECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION\nTECHNICAL_SUPPORT_TOPIC_TERRAFORM_PROVIDER.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TOPIC_UNKNOWN"
},
"spec.tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type": {
"type": "string",
"description": "Several types of issues are supported, such as problems, questions.\n\nUnknown or empty ticket type\nIndicates a problem (e.g. Misconfiguration)\nIndicates a task (a request to do something)\nIndicates a question (billing, services related)\nIndicates an incident (something is not working)\nIndicates a technical support ticket\nIndicates an account support ticket\nIndicates an Incident support ticket.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TYPE_UNKNOWN"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "list_customer_supports",
"description": "List all tenant tickets.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/admin/customer_supports",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_customer_support",
"description": "GET Customer Support.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/customer_supports/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"data-exposure-suggestion": {
"name": "data-exposure-suggestion",
"displayName": "Data Exposure Suggestion",
"operations": [
{
"name": "create_data_exposure_suggestion",
"description": "Suggest sensitive data rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/data_exposure/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested sensitive data rule for a given path.",
"title": "GetSuggestedSensitiveDataRuleReq",
"x-displayname": "GET Suggested Sensitive Data Rule Request.",
"x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedSensitiveDataRuleReq",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this sensitive data rule applied.",
"title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this sensitive data rule applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the sensitive data to.",
"title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested sensitive data rule for a given path.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedSensitiveDataRuleReq",
"required_fields": [
"path"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedSensitiveDataRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  path: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"path\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"path": "value"
}
},
"requiredFields": [
"path"
],
"description": "Minimum configuration for app_securityGetSuggestedSensitiveDataRuleReq"
},
"fieldMetadata": {
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this sensitive data rule applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the sensitive data to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"data-groups": {
"name": "data-groups",
"displayName": "Data Groups",
"operations": [
{
"name": "create_data_group",
"description": "Create Data group.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/data_groups",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of data_group",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.data_group.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/bigcnedata_groupCreateSpecType"
}
],
"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 data_groupCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_groupCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for data_groupCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create data group in a given namespace. If one already exists it will give an error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_records": {
"type": "object",
"description": "Data group with address record List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_records.records": {
"type": "object",
"description": "Configuration parameter for records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.integer_records": {
"type": "object",
"description": "Data group with integer record List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.integer_records.records": {
"type": "object",
"description": "Configuration parameter for records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.string_records": {
"type": "object",
"description": "Data group with strings record List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.string_records.records": {
"type": "object",
"description": "Configuration parameter for records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.data_group_type": [
"address_records",
"integer_records",
"string_records"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_data_group",
"description": "Replace Data Group.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/data_groups/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a data_group",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.data_group.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/bigcnedata_groupReplaceSpecType"
}
],
"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 data_groupReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_groupReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for data_groupReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Data Group in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_records": {
"type": "object",
"description": "Data group with address record List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address_records.records": {
"type": "object",
"description": "Configuration parameter for records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.integer_records": {
"type": "object",
"description": "Data group with integer record List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.integer_records.records": {
"type": "object",
"description": "Configuration parameter for records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.string_records": {
"type": "object",
"description": "Data group with strings record List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.string_records.records": {
"type": "object",
"description": "Configuration parameter for records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.data_group_type": [
"address_records",
"integer_records",
"string_records"
]
}
},
{
"name": "list_data_groups",
"description": "List Data Group.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/data_groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_data_group",
"description": "DELETE Data Group.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/data_groups/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a data_group",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.data_group.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for data_groupDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_groupDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
}
},
{
"name": "get_data_group",
"description": "GET Data Group.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/data_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"data-intelligence": {
"name": "data-intelligence",
"displayName": "Data Intelligence",
"operations": [
{
"name": "create_data_intelligence",
"description": "Create Data Delivery.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of receiver",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.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/receiverCreateSpecType"
}
],
"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 receiverCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for receiverCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for receiverCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new Data Delivery object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver": {
"type": "object",
"description": "Azure Blob Configuration for Data Delivery.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.connection_string": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.container_name": {
"type": "string",
"description": "Container Name is the name of the container into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.datadog_receiver": {
"type": "object",
"description": "Configuration for Datadog endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.datadog_api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.endpoint": {
"type": "string",
"description": "Exclusive with [site]\nDatadog Endpoint,.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.site": {
"type": "string",
"description": "Exclusive with [endpoint]\nDatadog Site,.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dataset_type": {
"type": "string",
"description": "Select the Data Set.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver": {
"type": "object",
"description": "GCP Bucket Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.bucket": {
"type": "string",
"description": "GCP Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.gcp_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver": {
"type": "object",
"description": "Configuration for HTTP endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_basic": {
      "type": "object",
"description": "Authentication parameters to access HTTP Log Receiver Endpoint.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_token": {
      "type": "object",
"description": "Authentication Token for access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.uri": {
"type": "string",
"description": "HTTP URI is the URI of the HTTP endpoint to send logs to,.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver": {
"type": "object",
"description": "S3 Configuration for Data Delivery.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_region": {
"type": "string",
"description": "AWS Region Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.bucket": {
"type": "string",
"description": "S3 Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver": {
"type": "object",
"description": "Configuration for Splunk HEC Logs endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.endpoint": {
"type": "string",
"description": "Splunk HEC Logs Endpoint,.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.splunk_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.splunk_hec_token": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.receiver": [
"azure_receiver",
"datadog_receiver",
"gcp_bucket_receiver",
"http_receiver",
"s3_receiver",
"splunk_receiver"
],
"spec.azure_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.azure_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.azure_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.azure_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.azure_receiver.connection_string.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.datadog_receiver.endpoint_choice": [
"endpoint",
"site"
],
"spec.datadog_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.datadog_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.datadog_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.datadog_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.datadog_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.datadog_receiver.datadog_api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.datadog_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.datadog_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.datadog_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.datadog_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.gcp_bucket_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.gcp_bucket_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.http_receiver.auth_choice": [
      "auth_basic",
      "auth_none",
      "auth_token"
      ],
"spec.http_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.http_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.http_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.http_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.http_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.http_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.http_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.http_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.http_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.s3_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.s3_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.s3_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.s3_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.splunk_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.splunk_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.splunk_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.splunk_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.splunk_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.splunk_receiver.splunk_hec_token.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.splunk_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.splunk_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.splunk_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.splunk_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_data_intelligence",
"description": "Replace Data Delivery.",
"method": "PUT",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a receiver",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/receiverReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for receiverReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for receiverReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for receiverReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of an Data Delivery object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver": {
"type": "object",
"description": "Azure Blob Configuration for Data Delivery.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.connection_string": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.container_name": {
"type": "string",
"description": "Container Name is the name of the container into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.datadog_receiver": {
"type": "object",
"description": "Configuration for Datadog endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.datadog_api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.endpoint": {
"type": "string",
"description": "Exclusive with [site]\nDatadog Endpoint,.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.site": {
"type": "string",
"description": "Exclusive with [endpoint]\nDatadog Site,.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dataset_type": {
"type": "string",
"description": "Select the Data Set.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver": {
"type": "object",
"description": "GCP Bucket Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.bucket": {
"type": "string",
"description": "GCP Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.gcp_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver": {
"type": "object",
"description": "Configuration for HTTP endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_basic": {
      "type": "object",
"description": "Authentication parameters to access HTTP Log Receiver Endpoint.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_token": {
      "type": "object",
"description": "Authentication Token for access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.uri": {
"type": "string",
"description": "HTTP URI is the URI of the HTTP endpoint to send logs to,.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver": {
"type": "object",
"description": "S3 Configuration for Data Delivery.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_region": {
"type": "string",
"description": "AWS Region Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.bucket": {
"type": "string",
"description": "S3 Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver": {
"type": "object",
"description": "Configuration for Splunk HEC Logs endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.endpoint": {
"type": "string",
"description": "Splunk HEC Logs Endpoint,.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.splunk_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.splunk_hec_token": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.receiver": [
"azure_receiver",
"datadog_receiver",
"gcp_bucket_receiver",
"http_receiver",
"s3_receiver",
"splunk_receiver"
],
"spec.azure_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.azure_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.azure_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.azure_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.azure_receiver.connection_string.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.datadog_receiver.endpoint_choice": [
"endpoint",
"site"
],
"spec.datadog_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.datadog_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.datadog_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.datadog_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.datadog_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.datadog_receiver.datadog_api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.datadog_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.datadog_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.datadog_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.datadog_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.gcp_bucket_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.gcp_bucket_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.http_receiver.auth_choice": [
      "auth_basic",
      "auth_none",
      "auth_token"
      ],
"spec.http_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.http_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.http_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.http_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.http_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.http_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.http_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.http_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.http_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.s3_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.s3_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.s3_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.s3_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.splunk_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.splunk_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.splunk_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.splunk_receiver.batch.batch_timeout": [
"default_timeout_seconds",
"timeout_seconds"
],
"spec.splunk_receiver.compression.compression_choice": [
"gzip_compression",
"no_compression"
],
"spec.splunk_receiver.splunk_hec_token.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.splunk_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.splunk_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.splunk_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.splunk_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
]
}
},
{
"name": "list_data_intelligence",
"description": "List Data Delivery.",
"method": "GET",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_data_intelligence",
"description": "DELETE Data Delivery.",
"method": "DELETE",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a receiver",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for receiverDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for receiverDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_data_intelligence",
"description": "GET Data Delivery.",
"method": "GET",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"data-intelligence-data-intelligence-addon-subscribe": {
"name": "data-intelligence-data-intelligence-addon-subscribe",
"displayName": "Data Intelligence Data Intelligence Addon Subscribe",
"operations": [
{
"name": "create_data_intelligence_data_intelligence_addon_subscribe",
"description": "Subscribe to Data Intelligence.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/system/data-intelligence/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request of subscribe to Data-Intelligence.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeRequest",
"x-f5xc-description-short": "Request of subscribe to Data-Intelligence.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"data-intelligence-data-intelligence-addon-unsubscribe": {
"name": "data-intelligence-data-intelligence-addon-unsubscribe",
"displayName": "Data Intelligence Data Intelligence Addon Unsubscribe",
"operations": [
{
"name": "create_data_intelligence_data_intelligence_addon_unsubscribe",
"description": "Unsubscribe to Client-Side Defense.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/system/data-intelligence/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request of unsubscribe to Data-Intelligence.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request of unsubscribe to Data-Intelligence.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"data-intelligence-dataSets": {
"name": "data-intelligence-dataSets",
"displayName": "Data Intelligence Datasets",
"operations": [
{
"name": "list_data_intelligence_dataSets",
"description": "GET Data Sets.",
"method": "GET",
"path": "/api/data-intelligence/namespaces/system/dataSets",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"dataSets": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "dataSets",
"type": "array",
"description": "Data or content configuration"
}
]
}
]
},
	"data-intelligence-datadictionary": {
"name": "data-intelligence-datadictionary",
"displayName": "Data Intelligence Datadictionary",
"operations": [
{
"name": "get_data_intelligence_datadictionary",
"description": "GET Data Dictionary.",
"method": "GET",
"path": "/api/data-intelligence/namespaces/system/datadictionary/{dataset}",
      "dangerLevel": "low",
"parameters": [
{
"name": "dataset",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"feature_list": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "feature_list",
"type": "array",
"description": "List of features for requested dataset."
}
]
}
]
},
	"data-intelligence-datasets": {
"name": "data-intelligence-datasets",
"displayName": "Data Intelligence Datasets",
"operations": [
{
"name": "list_data_intelligence_datasets",
"description": "List DataSets.",
"method": "GET",
"path": "/api/data-intelligence/namespaces/{namespace}/data-dictionary/datasets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"dataset_list": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "dataset_list",
"type": "array",
"description": "List of datasets for tenant."
}
]
}
]
},
	"data-intelligence-flowlabels": {
"name": "data-intelligence-flowlabels",
"displayName": "Data Intelligence Flowlabels",
"operations": [
{
"name": "list_data_intelligence_flowlabels",
"description": "List FlowLabels.",
"method": "GET",
"path": "/api/data-intelligence/namespaces/{namespace}/di/flowlabels",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"flowLabels": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "flowLabels",
"type": "array",
"description": "Flow labels."
}
]
}
]
},
	"data-intelligence-init-request": {
"name": "data-intelligence-init-request",
"displayName": "Data Intelligence Init Request",
"operations": [
{
"name": "create_data_intelligence_init_request",
"description": "Enable Data Intelligence.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/system/init-request",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"title": "Empty",
"x-displayname": "Empty",
"x-ves-proto-message": "ves.io.schema.Empty",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schemaEmpty",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schemaEmpty\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schemaEmpty"
}
}
]
},
	"data-intelligence-status": {
"name": "data-intelligence-status",
"displayName": "Data Intelligence Status",
"operations": [
{
"name": "create_data_intelligence_statu",
"description": "Update Status of Receiver.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers/{id}/status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update.",
"title": "UpdateReceiverStatusRequest",
"x-displayname": "Update Receiver status request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.UpdateReceiverStatusRequest",
"properties": {
"id": {
"type": "string",
"description": "Receiver Name.",
"title": "id",
"x-displayname": "Receiver ID.",
"x-ves-example": "Splunk-cloud-receiver.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-example": "splunk-cloud-receiver",
"x-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/shapedata_deliveryStatusType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for data_deliveryUpdateReceiverStatusRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_deliveryUpdateReceiverStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"receiver_name": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for data_deliveryUpdateReceiverStatusRequest"
},
"fieldMetadata": {
"id": {
"type": "string",
"description": "Receiver Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"type": {
"type": "string",
"description": "Type of Status\n\n- DISABLE: DISABLE\n\nDisable Receiver\n- ENABLE: ENABLE\n\nEnable Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISABLE"
}
},
"responseSummary": [
{
"field": "id",
"type": "string",
"description": "ID of the receiver."
},
{
"field": "receiver_name",
"type": "string",
"description": "Name of the receiver configured by the customer."
},
{
"field": "status",
"type": "string",
"description": "Values: not_modified , success\nStatus about receiver status modification."
}
]
}
]
},
	"data-intelligence-summary": {
"name": "data-intelligence-summary",
"displayName": "Data Intelligence Summary",
"operations": [
{
"name": "create_data_intelligence_summary",
"description": "Load Executive Summary.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/{namespace}/di/summary",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request object to GET executive summary of DI premium customer.",
"title": "LoadExecutiveSummaryRequest",
"x-displayname": "Load Executive Summary Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.LoadExecutiveSummaryRequest",
"properties": {
"anomalousScorePercentile": {
"type": "number",
"description": "Percentile of anomalous score.",
"title": "AnomalousScorePercentile",
"format": "double",
"x-displayname": "AnomalousScorePercentile.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"flowLabels": {
"type": "array",
"description": "FlowLabel for filtering the data.",
"title": "FlowLabels",
"items": {
"$ref": "#/components/schemas/data_deliveryFlowLabel"
},
"x-displayname": "Flow Labels.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"granularity": {
"type": "string",
"description": "Granularity of the data points (\"1m\", \"5m\", etc.)",
"title": "Granularity",
"x-displayname": "Granularity.",
"x-ves-example": "5m",
"x-f5xc-example": "5m",
"x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"platform": {
"type": "string",
"description": "Platform criteria for filtering the data.",
"title": "Platform",
"x-displayname": "Platform",
"x-ves-example": "Linux",
"x-f5xc-example": "linux",
"x-f5xc-description-short": "Platform criteria for filtering the data.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"timeRange": {
"type": "string",
"description": "Time range (\"1h\", \"7d\", etc.)",
"title": "TimeRange",
"x-displayname": "Time Range.",
"x-ves-example": "1h",
"x-f5xc-example": "1h",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"timestamp": {
"type": "string",
"description": "Unix timestamp (seconds since epoch)",
"title": "Timestamp",
"format": "int64",
"x-displayname": "Timestamp",
"x-f5xc-example": "2025-01-15T10:30:00Z",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "int64",
"minLength": 20,
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$",
"formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request object to GET executive summary of DI premium customer.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for data_deliveryLoadExecutiveSummaryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_deliveryLoadExecutiveSummaryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {
"eventsReasons": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for data_deliveryLoadExecutiveSummaryRequest"
},
"fieldMetadata": {
"anomalousScorePercentile": {
"type": "number",
"description": "Percentile of anomalous score.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"flowLabels": {
"type": "array",
"description": "FlowLabel for filtering the data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"granularity": {
"type": "string",
"description": "Granularity of the data points (\"1m\", \"5m\", etc.)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"platform": {
"type": "string",
"description": "Platform criteria for filtering the data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"timeRange": {
"type": "string",
"description": "Time range (\"1h\", \"7d\", etc.)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"timestamp": {
"type": "string",
"description": "Unix timestamp (seconds since epoch)",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "int64",
"minLength": 20,
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$",
"formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "eventsReasons",
"type": "array",
"description": "Message representing the transaction data."
},
{
"field": "lineChartData",
"type": "object",
"description": ""
},
{
"field": "summary",
"type": "object",
"description": ""
}
]
}
]
},
	"data-intelligence-test": {
"name": "data-intelligence-test",
"displayName": "Data Intelligence Test",
"operations": [
{
"name": "create_data_intelligence_test",
"description": "Test Receiver.",
"method": "POST",
"path": "/api/data-intelligence/namespaces/{namespace}/receivers/{id}/test",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to test receiver & destination sink.",
"title": "Test Receiver Request",
"x-displayname": "Test Receiver Request.",
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.TestReceiverRequest",
"properties": {
"id": {
"type": "string",
"description": "Receiver Name.",
"title": "id",
"x-displayname": "Receiver ID.",
"x-ves-example": "Splunk-cloud-receiver.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-example": "splunk-cloud-receiver",
"x-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the receiver is configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to test receiver & destination sink.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for data_deliveryTestReceiverRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_deliveryTestReceiverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "cdn"
},
"responseSchema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for data_deliveryTestReceiverRequest"
},
"fieldMetadata": {
"id": {
"type": "string",
"description": "Receiver Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "message",
"type": "string",
"description": "The error string if the status is failed."
},
{
"field": "status",
"type": "object",
"description": ""
}
]
}
]
},
	"data-types": {
"name": "data-types",
"displayName": "Data Types",
"operations": [
{
"name": "create_data_type",
"description": "Create Data Type.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/data_types",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of data_type",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.data_type.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/data_typeCreateSpecType"
}
],
"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 data_typeCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_typeCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for data_typeCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create data_type creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compliances": {
"type": "array",
"description": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 17,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.is_pii": {
"type": "boolean",
"description": "Select this option to classify the custom data type as personally identifiable information (PII)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.is_sensitive_data": {
"type": "boolean",
"description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_data_type",
"description": "Replace Data Type.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/data_types/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a data_type",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.data_type.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/data_typeReplaceSpecType"
}
],
"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 data_typeReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_typeReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for data_typeReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace data_type replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compliances": {
"type": "array",
"description": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 17,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.is_pii": {
"type": "boolean",
"description": "Select this option to classify the custom data type as personally identifiable information (PII)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.is_sensitive_data": {
"type": "boolean",
"description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_data_types",
"description": "List Data Type.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/data_types",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_data_type",
"description": "DELETE Data Type.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/data_types/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a data_type",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.data_type.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for data_typeDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for data_typeDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
}
},
{
"name": "get_data_type",
"description": "GET Data Type.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/data_types/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dc-cluster-groups": {
"name": "dc-cluster-groups",
"displayName": "Dc Cluster Groups",
"operations": [
{
"name": "create_dc_cluster_group",
"description": "Create DC Cluster Group.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/dc_cluster_groups",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of dc_cluster_group",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.dc_cluster_group.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/dc_cluster_groupCreateSpecType"
}
],
"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 dc_cluster_groupCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dc_cluster_groupCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dc_cluster_groupCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create DC Cluster group in given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type": {
"type": "object",
"description": "Details of DC Cluster Group Mesh Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.type.dc_cluster_group_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_dc_cluster_group",
"description": "Replace DC Cluster Group.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/dc_cluster_groups/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a dc_cluster_group",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.dc_cluster_group.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/dc_cluster_groupReplaceSpecType"
}
],
"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 dc_cluster_groupReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dc_cluster_groupReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dc_cluster_groupReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace given DC Cluster Group in given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type": {
"type": "object",
"description": "Details of DC Cluster Group Mesh Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.type.dc_cluster_group_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
]
}
},
{
"name": "list_dc_cluster_groups",
"description": "List DC Cluster Group.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dc_cluster_groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_dc_cluster_group",
"description": "DELETE DC Cluster Group.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/dc_cluster_groups/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a dc_cluster_group",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.dc_cluster_group.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dc_cluster_groupDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dc_cluster_groupDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_dc_cluster_group",
"description": "GET DC Cluster Group.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dc_cluster_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ddos-mitigation-suggestion": {
"name": "ddos-mitigation-suggestion",
"displayName": "Ddos Mitigation Suggestion",
"operations": [
{
"name": "create_ddos_mitigation_suggestion",
"description": "Suggest CDN DDoS Mitigation rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/ddos_mitigation/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested blocking DDoSMitigtionRule for a given IP/ASN/Country/TLS.",
"title": "GetSuggestedDDoSMitigtionRuleReq",
"x-displayname": "GET Suggested DDoS Mitigtion Rule Request.",
"x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedDDoSMitigtionRuleReq",
"properties": {
"asn_list": {
"allOf": [
{
"$ref": "#/components/schemas/policyAsnMatchList"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"country_list": {
"type": "array",
"description": "Sources that are located in one of the countries in the given list.",
"title": "country_list",
"maxItems": 64,
"items": {
"$ref": "#/components/schemas/policyCountryCode"
},
"x-displayname": "Country List.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "64",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "64",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Sources that are located in one of the countries in the given list.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ip_prefix_list": {
"allOf": [
{
"$ref": "#/components/schemas/policyPrefixMatchList"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ja4_tls_fingerprint_matcher": {
"allOf": [
{
"$ref": "#/components/schemas/policyJA4TlsFingerprintMatcherType"
}
],
"x-f5xc-description-short": "Configuration parameter for ja4 tls fingerprint matcher.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Load balancer for which this WAF exclusion will be applied.",
"title": "Name",
"x-displayname": "Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "Load balancer for which this WAF exclusion will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"tls_fingerprint_matcher": {
"allOf": [
{
"$ref": "#/components/schemas/policyTlsFingerprintMatcherType"
}
],
"x-f5xc-description-short": "Configuration parameter for tls fingerprint matcher.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested blocking DDoSMitigtionRule for a given IP/ASN/Country/TLS.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedDDoSMitigtionRuleReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedDDoSMitigtionRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"mitigation_rule_name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securityGetSuggestedDDoSMitigtionRuleReq"
},
"fieldMetadata": {
"asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"asn_list.as_numbers": {
"type": "array",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"country_list": {
"type": "array",
"description": "Sources that are located in one of the countries in the given list.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ip_prefix_list": {
"type": "object",
"description": "List of IP Prefix strings to match against.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ip_prefix_list.invert_match": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ip_prefix_list.ip_prefixes": {
"type": "array",
"description": "List of IPv4 prefix strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ja4_tls_fingerprint_matcher": {
"type": "object",
"description": "An extended version of JA3 that includes additional fields for more comprehensive fingerprinting of\nSSL/TLS clients and potentially has a different structure and length.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ja4_tls_fingerprint_matcher.exact_values": {
"type": "array",
"description": "A list of exact JA4 TLS fingerprint to match the input JA4 TLS fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Load balancer for which this WAF exclusion will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tls_fingerprint_matcher": {
"type": "object",
"description": "A TLS fingerprint matcher specifies multiple criteria for matching a TLS fingerprint. The set of supported positive match criteria includes a list of known\nclasses of TLS fingerprints and a list of exact values. The match is considered successful if either of these positive criteria are satisfied and the input\nfingerprint is not one of the excluded values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tls_fingerprint_matcher.classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tls_fingerprint_matcher.exact_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tls_fingerprint_matcher.excluded_values": {
"type": "array",
"description": "A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one\nor more known TLS fingerprint classes in the enclosing matcher.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_mitigation_rule",
"type": "object",
"description": ""
},
{
"field": "mitigation_rule",
"type": "object",
"description": ""
},
{
"field": "mitigation_rule_name",
"type": "string",
"description": "HTTP load balancer for which this DDoS Mitigation Rule will be applied."
}
]
}
]
},
	"delete": {
"name": "delete",
"displayName": "Delete",
"operations": [
{
"name": "create_delete",
"description": "DELETE",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/known_label/delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Deletes Label matching label.key=label.value.",
      "title": "Delete Label",
"x-displayname": "DELETE Label Request.",
"x-ves-proto-message": "ves.io.schema.known_label.DeleteRequest",
"properties": {
"key": {
      "type": "string",
"description": "Key of the label to be deleted.",
      "title": "Key",
      "x-displayname": "Key",
      "x-ves-example": "VES.I/O/region.",
"x-f5xc-example": "F5 XC/region",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the label to be deleted.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"value": {
"type": "string",
"description": "Value of the label to be deleted.",
"title": "Value",
"x-displayname": "Value",
"x-ves-example": "VES-I/O-par.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.k8s_label_value": "true"
},
"x-f5xc-example": "ves-io-par",
"x-validation-rules": {
"ves.io.schema.rules.string.k8s_label_value": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Deletes Label matching label.key=label.value.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for known_labelDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for known_labelDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "users"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for known_labelDeleteRequest"
},
"fieldMetadata": {
"key": {
      "type": "string",
"description": "Key of the label to be deleted.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the label to be deleted.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"value": {
"type": "string",
"description": "Value of the label to be deleted.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"discovery": {
"name": "discovery",
"displayName": "Discovery",
"operations": [
{
"name": "list_discovery",
"description": "List Discovered Services.",
"method": "GET",
"path": "/api/discovery/namespaces/{namespace}/discovered_services",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_discovery",
"description": "GET Discovered Service Object.",
"method": "GET",
"path": "/api/discovery/namespaces/{namespace}/discovered_services/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "create_discovery",
"description": "Suggest Values.",
"method": "POST",
"path": "/api/discovery/namespaces/{namespace}/suggest-values",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"operationAliases": [
"ves.io.schema.discovered_service.CustomAPI.SuggestValues"
      ],
"bodySchema": {
"type": "object",
"description": "Request body of SuggestValues request.",
"title": "SuggestValuesReq",
"x-displayname": "Request for SuggestValues.",
"x-ves-proto-message": "ves.io.schema.discovery_cloud.SuggestValuesReq",
"properties": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"title": "field_path",
"maxLength": 1024,
"x-displayname": "Field Path.",
"x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match",
      "x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"title": "match_value",
"maxLength": 256,
"x-displayname": "Match Value.",
"x-ves-example": "Some-substring.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "some-substring",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"request_body": {
"allOf": [
{
"$ref": "#/components/schemas/protobufAny"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discovery_cloudSuggestValuesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discovery_cloudSuggestValuesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for discovery_cloudSuggestValuesReq"
},
"fieldMetadata": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body": {
"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\": <string>,\n\"lastName\": <string>\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}",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.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.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.value": {
"type": "string",
"description": "Must be a valid serialized protocol buffer of the above specified type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of suggested items."
}
]
}
]
},
	"discovery-create-http-load-balancer": {
"name": "discovery-create-http-load-balancer",
"displayName": "Discovery Create Http Load Balancer",
"operations": [
{
"name": "create_discovery_create_http_load_balancer",
"description": "Create HTTP/HTTPS load balancer.",
"method": "POST",
"path": "/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_http_load_balancer",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "CreateHTTPLoadBalancerRequest.",
"title": "CreateHTTPLoadBalancerRequest",
"x-displayname": "CreateHTTPLoadBalancerRequest.",
"x-ves-proto-message": "ves.io.schema.discovered_service.CreateHTTPLoadBalancerRequest",
"properties": {
"http_lb_request": {
"allOf": [
{
"$ref": "#/components/schemas/discovered_serviceHTTPLBRequest"
}
],
"x-f5xc-description-short": "Configuration parameter for http lb request.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discovered_serviceCreateHTTPLoadBalancerRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discovered_serviceCreateHTTPLoadBalancerRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for discovered_serviceCreateHTTPLoadBalancerRequest"
},
"fieldMetadata": {
"http_lb_request": {
"type": "object",
"description": "HTTP LB Request Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.default_caching_disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.default_caching_enable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.domain": {
"type": "string",
"description": "Domain name for routing and identification",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "fqdn",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"http_lb_request.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.http.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.http.site": {
"type": "object",
"description": "This defines a reference to a CE site where a load balancer could be advertised.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.http.virtual_site": {
"type": "object",
"description": "This defines a reference to a customer site virtual site where a load balancer could be advertised.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.https": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificate.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.https.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.https.certificates": {
"type": "array",
"description": "Select a certificate.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"http_lb_request.https.site": {
"type": "object",
"description": "This defines a reference to a CE site where a load balancer could be advertised.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.https.virtual_site": {
"type": "object",
"description": "This defines a reference to a customer site virtual site where a load balancer could be advertised.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.https_auto_cert": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.name": {
"type": "string",
"description": "The configuration object will be created with name. It has to be unique within the namespace.\nThe value of name has to follow DNS-1035 format.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"http_lb_request.skip_server_verification": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.trusted_ca": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.trusted_ca.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"http_lb_request.trusted_ca.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"http_lb_request.trusted_ca.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"http_lb_request.advertise_choice": [],
"http_lb_request.caching": [
"default_caching_disable",
"default_caching_enable"
],
"http_lb_request.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"http_lb_request.server_validation_choice": [
"skip_server_verification",
"trusted_ca"
],
"http_lb_request.http.advertise_choice": [
"advertise_on_public_default_vip",
"site",
"virtual_site"
],
"http_lb_request.https.advertise_choice": [
"advertise_on_public_default_vip",
"site",
"virtual_site"
]
},
"responseSummary": [
{
"field": "http_loadbalancer",
"type": "object",
"description": ""
}
]
}
]
},
	"discovery-create-tcp-load-balancer": {
"name": "discovery-create-tcp-load-balancer",
"displayName": "Discovery Create Tcp Load Balancer",
"operations": [
{
"name": "create_discovery_create_tcp_load_balancer",
"description": "Create TCP load balancer.",
"method": "POST",
"path": "/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_tcp_load_balancer",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "CreateTCPLoadBalancerRequest.",
"title": "CreateTCPLoadBalancerRequest",
"x-displayname": "CreateTCPLoadBalancerRequest.",
"x-ves-proto-message": "ves.io.schema.discovered_service.CreateTCPLoadBalancerRequest",
"properties": {
"name": {
"type": "string",
"description": "Identifies the discovered service name.",
"title": "Service Name",
"x-displayname": "Service Name.",
"x-ves-example": "Vs1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "vs1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"tcp_lb_request": {
"allOf": [
{
"$ref": "#/components/schemas/discovered_serviceTCPLBRequest"
}
],
"x-f5xc-description-short": "Configuration parameter for tcp lb request.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discovered_serviceCreateTCPLoadBalancerRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discovered_serviceCreateTCPLoadBalancerRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for discovered_serviceCreateTCPLoadBalancerRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Identifies the discovered service name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tcp_lb_request": {
"type": "object",
"description": "TCP LB Request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_lb_request.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_lb_request.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tcp_lb_request.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_lb_request.domain": {
"type": "string",
"description": "Domain name for routing and identification",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "fqdn",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tcp_lb_request.listen_port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nListen Port for this load balancer.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_lb_request.name": {
"type": "string",
"description": "The configuration object will be created with name. It has to be unique within the namespace.\nThe value of name has to follow DNS-1035 format.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tcp_lb_request.no_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_lb_request.port_ranges": {
"type": "string",
"description": "Exclusive with [listen_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tcp_lb_request.sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"tcp_lb_request.advertise_choice": [
"advertise_custom",
"advertise_on_public_default_vip"
],
"tcp_lb_request.port_choice": [
"listen_port",
"port_ranges"
],
"tcp_lb_request.sni_default_lb_choice": [
"no_sni",
"sni"
]
},
"responseSummary": [
{
"field": "tcp_loadbalancer",
"type": "object",
"description": ""
}
]
}
]
},
	"discovery-custom": {
"name": "discovery-custom",
"displayName": "Discovery Custom",
"operations": [
{
"name": "list_discovery_custom",
"description": "List discovered services of specific type.",
"method": "GET",
"path": "/api/discovery/custom/namespaces/{namespace}/discovered_services",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "service_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "discovery_name",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
}
]
},
	"discovery-disable-visibility": {
"name": "discovery-disable-visibility",
"displayName": "Discovery Disable Visibility",
"operations": [
{
"name": "create_discovery_disable_visibility",
"description": "Disable visibility in all workspaces.",
"method": "POST",
"path": "/api/discovery/namespaces/{namespace}/discovered_services/{name}/disable_visibility",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Disable visibility on the discovered service.",
"title": "DisableVisibilityRequest",
"x-displayname": "Disable visibility on the discovered service.",
"x-ves-proto-message": "ves.io.schema.discovered_service.DisableVisibilityRequest",
"properties": {
"name": {
"type": "string",
"description": "Identifies the discovered service name.",
"title": "Service Name",
"x-displayname": "Service Name.",
"x-ves-example": "Vs1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "vs1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Disable visibility on the discovered service.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discovered_serviceDisableVisibilityRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discovered_serviceDisableVisibilityRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for discovered_serviceDisableVisibilityRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Identifies the discovered service name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"discovery-enable-visibility": {
"name": "discovery-enable-visibility",
"displayName": "Discovery Enable Visibility",
"operations": [
{
"name": "create_discovery_enable_visibility",
"description": "Enable visibility in all workspaces.",
"method": "POST",
"path": "/api/discovery/namespaces/{namespace}/discovered_services/{name}/enable_visibility",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Enable visibility of the discovered service in all workspaces like WAAP, App Connect, etc.",
"title": "EnableVisibilityRequest",
"x-displayname": "Enable visibility.",
"x-ves-proto-message": "ves.io.schema.discovered_service.EnableVisibilityRequest",
"properties": {
"name": {
"type": "string",
"description": "Identifies the discovered service name.",
"title": "Service Name",
"x-displayname": "Service Name.",
"x-ves-example": "Vs1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "vs1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Enable visibility of the discovered service in all workspaces like WAAP, App Connect, etc.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discovered_serviceEnableVisibilityRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discovered_serviceEnableVisibilityRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for discovered_serviceEnableVisibilityRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Identifies the discovered service name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "virtual_host_ref",
"type": "object",
"description": ""
}
]
}
]
},
	"discoverys": {
"name": "discoverys",
"displayName": "Discoverys",
"operations": [
{
"name": "create_discovery_discoverys",
"description": "Create Discovery.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/discoverys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of discovery",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.discovery.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/discoveryCreateSpecType"
}
],
"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 discoveryCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discoveryCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for discoveryCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to create discovery object for a site or virtual site in system namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_id": {
"type": "string",
"description": "Exclusive with [no_cluster_id]\nSpecify identifier for discovery cluster. This identifier can be\nspecified in endpoint object to discover only from this discovery object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_consul": {
"type": "object",
"description": "Discovery configuration for Hashicorp Consul.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_consul.access_info": {
      "type": "object",
"description": "Hashicorp Consul API server information.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_consul.publish_info": {
"type": "object",
"description": "Consul Configuration to publish VIPs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s": {
"type": "object",
"description": "Discovery configuration for K8s.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.access_info": {
      "type": "object",
"description": "K8s API server access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.default_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.namespace_mapping": {
"type": "object",
"description": "Select the mapping between K8s namespaces from which services will be discovered and App Namespace to which the discovered services will be shared.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.publish_info": {
"type": "object",
"description": "K8s Configuration to publish VIPs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_cluster_id": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cluster_identifier_choice": [
"cluster_id",
"no_cluster_id"
],
"spec.discovery_choice": [
"discovery_consul",
"discovery_k8s"
],
"spec.discovery_consul.namespace_mapping_choice": [],
"spec.discovery_consul.publish_info.publish_choice": [
"disable",
"publish"
],
"spec.discovery_k8s.namespace_mapping_choice": [
"default_all",
"namespace_mapping"
],
"spec.discovery_k8s.access_info.config_type": [
      "connection_info",
"kubeconfig_url"
],
"spec.discovery_k8s.access_info.k8s_pod_network_choice": [
      "isolated",
"reachable"
],
"spec.discovery_k8s.publish_info.publish_choice": [
"disable",
"dns_delegation",
"publish",
"publish_fqdns"
],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_discovery",
"description": "Replace Discovery.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/discoverys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a discovery",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.discovery.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/discoveryReplaceSpecType"
}
],
"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 discoveryReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discoveryReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for discoveryReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to replace discovery object for a site or virtual site in system namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_id": {
"type": "string",
"description": "Exclusive with [no_cluster_id]\nSpecify identifier for discovery cluster. This identifier can be\nspecified in endpoint object to discover only from this discovery object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_consul": {
"type": "object",
"description": "Discovery configuration for Hashicorp Consul.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_consul.access_info": {
      "type": "object",
"description": "Hashicorp Consul API server information.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_consul.publish_info": {
"type": "object",
"description": "Consul Configuration to publish VIPs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s": {
"type": "object",
"description": "Discovery configuration for K8s.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.access_info": {
      "type": "object",
"description": "K8s API server access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.default_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.namespace_mapping": {
"type": "object",
"description": "Select the mapping between K8s namespaces from which services will be discovered and App Namespace to which the discovered services will be shared.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_k8s.publish_info": {
"type": "object",
"description": "K8s Configuration to publish VIPs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_cluster_id": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.cluster_identifier_choice": [
"cluster_id",
"no_cluster_id"
],
"spec.discovery_choice": [
"discovery_consul",
"discovery_k8s"
],
"spec.discovery_consul.namespace_mapping_choice": [],
"spec.discovery_consul.publish_info.publish_choice": [
"disable",
"publish"
],
"spec.discovery_k8s.namespace_mapping_choice": [
"default_all",
"namespace_mapping"
],
"spec.discovery_k8s.access_info.config_type": [
      "connection_info",
"kubeconfig_url"
],
"spec.discovery_k8s.access_info.k8s_pod_network_choice": [
      "isolated",
"reachable"
],
"spec.discovery_k8s.publish_info.publish_choice": [
"disable",
"dns_delegation",
"publish",
"publish_fqdns"
],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
}
},
{
"name": "list_discoverys",
"description": "List Discovery.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/discoverys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_discovery",
"description": "DELETE Discovery.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/discoverys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a discovery",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.discovery.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discoveryDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discoveryDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_discovery_discoverys",
"description": "GET Discovery.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/discoverys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dns": {
"name": "dns",
"displayName": "Dns",
"operations": [
{
"name": "create_dn",
"description": "Create DNS Load Balancer Health Check.",
"method": "POST",
"path": "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of dns_lb_health_check",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.dns_lb_health_check.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/dns_lb_health_checkCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_lb_health_checkCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_lb_health_checkCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_lb_health_checkCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create DNS Load Balancer Health Check in a given namespace. If one already exist it will give a error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.disable_virtual_host": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.receive": {
"type": "string",
"description": "Regular expression used to match against the response to the health check's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.send": {
"type": "string",
"description": "HTTP payload to send to the target.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.virtual_host": {
"type": "string",
"description": "Exclusive with [disable_virtual_host]\nName of the virtual host to use for SNI.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.disable_virtual_host": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.https_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.receive": {
"type": "string",
"description": "Regular expression used to match against the response to the health check's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.send": {
"type": "string",
"description": "HTTP payload to send to the target.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.virtual_host": {
"type": "string",
"description": "Exclusive with [disable_virtual_host]\nName of the virtual host to use for SNI.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.icmp_health_check": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tcp_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.receive": {
"type": "string",
"description": "Regular expression used to match against the response to the monitor's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.send": {
"type": "string",
"description": "Send this string to target (default empty. When send and receive are both empty, monitor just tests 3WHS)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.receive": {
"type": "string",
"description": "Hex encoded raw bytes expected in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.send": {
"type": "string",
"description": "Hex encoded raw bytes sent in the request. Empty payloads imply a connect-only health check.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.udp_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp_health_check.receive": {
"type": "string",
"description": "UDP response to be matched. It can be a regex.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.udp_health_check.send": {
"type": "string",
"description": "UDP payload.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.health_check": [
"http_health_check",
"https_health_check",
"icmp_health_check",
"tcp_health_check",
"tcp_hex_health_check",
"udp_health_check"
],
"spec.http_health_check.virtual_host_choice": [
"disable_virtual_host",
"virtual_host"
],
"spec.https_health_check.virtual_host_choice": [
"disable_virtual_host",
"virtual_host"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_dn",
"description": "Replace DNS Load Balancer Health Check.",
"method": "PUT",
"path": "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a dns_lb_health_check",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.dns_lb_health_check.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/dns_lb_health_checkReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_lb_health_checkReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_lb_health_checkReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_lb_health_checkReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace DNS Load Balancer Health Check in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.disable_virtual_host": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.receive": {
"type": "string",
"description": "Regular expression used to match against the response to the health check's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.send": {
"type": "string",
"description": "HTTP payload to send to the target.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.virtual_host": {
"type": "string",
"description": "Exclusive with [disable_virtual_host]\nName of the virtual host to use for SNI.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.disable_virtual_host": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.https_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.receive": {
"type": "string",
"description": "Regular expression used to match against the response to the health check's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.send": {
"type": "string",
"description": "HTTP payload to send to the target.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_health_check.virtual_host": {
"type": "string",
"description": "Exclusive with [disable_virtual_host]\nName of the virtual host to use for SNI.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.icmp_health_check": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tcp_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.receive": {
"type": "string",
"description": "Regular expression used to match against the response to the monitor's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.send": {
"type": "string",
"description": "Send this string to target (default empty. When send and receive are both empty, monitor just tests 3WHS)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.receive": {
"type": "string",
"description": "Hex encoded raw bytes expected in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_hex_health_check.send": {
"type": "string",
"description": "Hex encoded raw bytes sent in the request. Empty payloads imply a connect-only health check.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp_health_check": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp_health_check.health_check_port": {
"type": "integer",
"description": "Port used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.udp_health_check.health_check_secondary_port": {
"type": "integer",
"description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp_health_check.receive": {
"type": "string",
"description": "UDP response to be matched. It can be a regex.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.udp_health_check.send": {
"type": "string",
"description": "UDP payload.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.health_check": [
"http_health_check",
"https_health_check",
"icmp_health_check",
"tcp_health_check",
"tcp_hex_health_check",
"udp_health_check"
],
"spec.http_health_check.virtual_host_choice": [
"disable_virtual_host",
"virtual_host"
],
"spec.https_health_check.virtual_host_choice": [
"disable_virtual_host",
"virtual_host"
]
}
},
{
"name": "list_dns",
"description": "List DNS Load Balancer Health Check.",
"method": "GET",
"path": "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_dn",
"description": "DELETE DNS Load Balancer Health Check.",
"method": "DELETE",
"path": "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a dns_lb_health_check",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.dns_lb_health_check.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_lb_health_checkDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_lb_health_checkDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
}
},
{
"name": "get_dn",
"description": "GET DNS Load Balancer Health Check.",
"method": "GET",
"path": "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dns-compliance-checkss": {
"name": "dns-compliance-checkss",
"displayName": "Dns Compliance Checkss",
"operations": [
{
"name": "create_dns_compliance_check",
"description": "Create DNS Compliance Checks.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/dns_compliance_checkss",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of dns_compliance_checks",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.dns_compliance_checks.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/dns_compliance_checksCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_compliance_checksCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_compliance_checksCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_compliance_checksCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create DNS Compliance Checks Specification in a given namespace. If one already exists it will give an error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disallowed_query_type_list": {
"type": "array",
"description": "Disallowed Query Type Values.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disallowed_resource_record_type_list": {
"type": "array",
"description": "Disallowed Resource Record Type List.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_denylist": {
"type": "array",
"description": "List of domains to be denied by configuration object.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 30,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_dns_compliance_check",
"description": "Replace DNS Compliance Checks.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/dns_compliance_checkss/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a dns_compliance_checks",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.dns_compliance_checks.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/dns_compliance_checksReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_compliance_checksReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_compliance_checksReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_compliance_checksReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace DNS Compliance Checks specification in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disallowed_query_type_list": {
"type": "array",
"description": "Disallowed Query Type Values.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disallowed_resource_record_type_list": {
"type": "array",
"description": "Disallowed Resource Record Type List.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_denylist": {
"type": "array",
"description": "List of domains to be denied by configuration object.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 30,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_dns_compliance_checkss",
"description": "List Configure DNS Compliance Checks.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dns_compliance_checkss",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_dns_compliance_check",
"description": "DELETE Configure DNS Compliance Checks.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/dns_compliance_checkss/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a dns_compliance_checks",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.dns_compliance_checks.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_compliance_checksDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_compliance_checksDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
}
},
{
"name": "get_dns_compliance_check",
"description": "GET DNS Compliance Checks.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dns_compliance_checkss/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dns-dns-management-addon-subscribe": {
"name": "dns-dns-management-addon-subscribe",
"displayName": "Dns Dns Management Addon Subscribe",
"operations": [
{
"name": "create_dns_dns_management_addon_subscribe",
"description": "Subscribe to DNS Management.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_management/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to DNS Management.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.subscription.SubscribeRequest",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"dns-dns-management-addon-unsubscribe": {
"name": "dns-dns-management-addon-unsubscribe",
"displayName": "Dns Dns Management Addon Unsubscribe",
"operations": [
{
"name": "create_dns_dns_management_addon_unsubscribe",
"description": "Unsubscribe to DNS Management.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_management/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to DNS Management.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to DNS Management.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"dns-dns-zone-clone-from-dns-domain": {
"name": "dns-dns-zone-clone-from-dns-domain",
"displayName": "Dns Dns Zone Clone From Dns Domain",
"operations": [
{
"name": "create_dns_dns_zone_clone_from_dns_domain",
"description": "Clone from DNSDomain.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zone/clone_from_dns_domain",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Clone Request.",
"title": "Clone Request",
"x-displayname": "Clone Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.CloneReq",
"properties": {
"tenant": {
"type": "string",
"description": "Tenant for which DNS domain cloned.",
"title": "Tenant name",
"x-displayname": "Tenant name.",
"x-f5xc-example": "customer-123",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only",
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_zoneCloneReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_zoneCloneReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"failed_zones": {
"type": "array"
},
"success_zones": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_zoneCloneReq"
},
"fieldMetadata": {
"tenant": {
"type": "string",
"description": "Tenant for which DNS domain cloned.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "failed_zones",
"type": "array",
"description": "Zones failed."
},
{
"field": "success_zones",
"type": "array",
"description": "Zones succeeded."
}
]
}
]
},
	"dns-dns-zone-import": {
"name": "dns-dns-zone-import",
"displayName": "Dns Dns Zone Import",
"operations": [
{
"name": "create_dns_dns_zone_import",
"description": "Import F5 Cloud Services DNS Zone.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zone/import",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Import F5 Cloud Services DNS zone.",
"title": "Import F5 Cloud Services DNS zone",
"x-displayname": "Import F5 Cloud Services DNS zone.",
"x-ves-proto-message": "ves.io.schema.dns_zone.ImportF5CSZoneRequest",
"properties": {
"configuration": {
"allOf": [
{
"$ref": "#/components/schemas/dns_zoneF5CSDNSZoneConfiguration"
}
],
"x-f5xc-description-short": "Configuration parameter for configuration.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_zoneImportF5CSZoneRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_zoneImportF5CSZoneRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_zoneImportF5CSZoneRequest"
},
"fieldMetadata": {
"configuration": {
"type": "object",
"description": "F5 Cloud Services DNS primary or secondary zone configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"configuration.adns_service": {
"type": "object",
"description": "Exclusive with [dns_service]\nF5 Cloud Services secondary zone configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"configuration.dns_service": {
"type": "object",
"description": "Exclusive with [adns_service]\nF5 Cloud Services primary zone configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"configuration.dns_type": [
"adns_service",
"dns_service"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"dns-dns-zone-import-axfr": {
"name": "dns-dns-zone-import-axfr",
"displayName": "Dns Dns Zone Import Axfr",
"operations": [
{
"name": "create_dns_dns_zone_import_axfr",
"description": "Import AXFR for Primary Zone.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zone/import_axfr",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "DNS zone import via AXFR.",
"title": "Import AXFR for Primary Zone",
"x-displayname": "Import AXFR for Primary Zone.",
"x-ves-displayorder": "7,3,8",
"x-ves-proto-message": "ves.io.schema.dns_zone.ImportAXFRRequest",
"properties": {
"domain_name": {
"type": "string",
"description": "Name of the zone to be imported.",
"title": "Domain Name",
"minLength": 1,
"maxLength": 256,
"x-displayname": "Domain Name.",
"x-ves-example": "example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.hostname": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.hostname": "true",
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9.-]",
"description": "Dot-separated DNS labels"
},
"format": "hostname",
"formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"primary_server": {
"type": "string",
"description": "Configuration parameter for primary server",
"title": "Primary Server",
"x-displayname": "Primary DNS Server.",
"x-ves-example": "192.0.2.103.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.ipv4": "true"
},
"x-f5xc-example": "192.0.2.103",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.ipv4": "true"
},
"x-f5xc-description-short": "Configuration parameter for primary server.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tsig_configuration": {
"allOf": [
{
"$ref": "#/components/schemas/dns_zoneTSIGConfiguration"
}
],
"x-f5xc-description-short": "Configuration parameter for tsig configuration.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_zoneImportAXFRRequest",
"required_fields": [
"domain_name",
"primary_server"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_zoneImportAXFRRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  domain_name: value\n  primary_server: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"domain_name\": \"value\",\n    \"primary_server\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"domain_name": "value",
"primary_server": "value"
}
},
"requiredFields": [
"domain_name",
"primary_server"
],
"description": "Minimum configuration for dns_zoneImportAXFRRequest"
},
"fieldMetadata": {
"domain_name": {
"type": "string",
"description": "Name of the zone to be imported.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9.-]",
"description": "Dot-separated DNS labels"
},
"format": "hostname",
"formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"primary_server": {
"type": "string",
"description": "Configuration parameter for primary server",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tsig_configuration": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tsig_configuration.tsig_key_algorithm": {
      "type": "string",
"description": "TSIG key value must be compatible with the specified algorithm\n\n- UNDEFINED: UNDEFINED\n\n- HMAC_MD5: HMAC_MD5\n\n- HMAC_SHA1: HMAC_SHA1\n\n- HMAC_SHA224: HMAC_SHA224\n\n- HMAC_SHA256: HMAC_SHA256\n\n- HMAC_SHA384: HMAC_SHA384\n\n- HMAC_SHA512: HMAC_SHA512.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNDEFINED"
},
"tsig_configuration.tsig_key_name": {
      "type": "string",
"description": "TSIG key name as used in TSIG protocol extension.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tsig_configuration.tsig_key_value": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tsig_configuration.tsig_key_value.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tsig_configuration.tsig_key_value.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"tsig_configuration.tsig_key_value.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "configuration",
"type": "object",
"description": ""
}
]
}
]
},
	"dns-dns-zone-import-bind-create": {
"name": "dns-dns-zone-import-bind-create",
"displayName": "Dns Dns Zone Import Bind Create",
"operations": [
{
"name": "create_dns_dns_zone_import_bind_create",
"description": "Import BIND Files.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zone/import_bind_create",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Import BIND Create Request",
"x-displayname": "Import BIND Create Request.",
"x-ves-displayorder": "2,1",
"x-ves-proto-message": "ves.io.schema.dns_zone.ImportBINDCreateRequest",
"properties": {
"description": {
"type": "string",
"description": "Optional description about zone, import method, etc.",
"title": "Description",
"x-displayname": "Description.",
"x-f5xc-description-short": "Optional description about zone, import method, etc.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"file": {
"type": "string",
"description": "Configuration parameter for file",
"title": "BIND Zip File",
"format": "byte",
"maximum": 2097152,
"x-displayname": "BIND Zip File.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.bytes.max_len": "2097152",
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.bytes.max_len": "2097152",
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "DNS zone for domain management and record configuration",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "dns_type",
"fields": [
"spec.primary",
"spec.secondary"
],
"reason": "Choose primary or secondary zone type (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example.com\n  namespace: system\nspec:\n  primary: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example.com\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"primary\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"invalid_zone_list": {
"type": "array"
},
"success_created_zone_count": {
"type": "integer"
},
"valid_zone_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example.com",
"namespace": "system"
},
"spec": {
"primary": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "DNS zone for domain management and record configuration"
},
"fieldMetadata": {
"description": {
"type": "string",
"description": "Optional description about zone, import method, etc.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"file": {
"type": "string",
"description": "Configuration parameter for file",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "invalid_zone_list",
"type": "array",
"description": "Zones that we failed to parse. On submission, objects will not be created for any detected zone in this list."
},
{
"field": "success_created_zone_count",
"type": "integer",
"description": "Number of items or occurrences"
},
{
"field": "valid_zone_list",
"type": "array",
"description": "Zones that we parsed successfully. On submission, objects will be created for every zone in this list."
}
]
}
]
},
	"dns-dns-zone-import-bind-validate": {
"name": "dns-dns-zone-import-bind-validate",
"displayName": "Dns Dns Zone Import Bind Validate",
"operations": [
{
"name": "create_dns_dns_zone_import_bind_validate",
"description": "Validate BIND Files.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zone/import_bind_validate",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Import BIND Validate Request",
"x-displayname": "Import BIND Validate Request.",
"x-ves-displayorder": "2,1",
"x-ves-proto-message": "ves.io.schema.dns_zone.ImportBINDValidateRequest",
"properties": {
"description": {
"type": "string",
"description": "Optional description about zone, import method, etc.",
"title": "Description",
"x-displayname": "Description.",
"x-f5xc-description-short": "Optional description about zone, import method, etc.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"file": {
"type": "string",
"description": "Configuration parameter for file",
"title": "BIND Zip File",
"format": "byte",
"maximum": 2097152,
"x-displayname": "BIND Zip File.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.bytes.max_len": "2097152",
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.bytes.max_len": "2097152",
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_zoneImportBINDValidateRequest",
"required_fields": [
"file"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_zoneImportBINDValidateRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  file: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"file\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"invalid_zone_list": {
"type": "array"
},
"success_created_zone_count": {
"type": "integer"
},
"valid_zone_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"file": "value"
}
},
"requiredFields": [
"file"
],
"description": "Minimum configuration for dns_zoneImportBINDValidateRequest"
},
"fieldMetadata": {
"description": {
"type": "string",
"description": "Optional description about zone, import method, etc.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"file": {
"type": "string",
"description": "Configuration parameter for file",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "invalid_zone_list",
"type": "array",
"description": "Zones that we failed to parse. On submission, objects will not be created for any detected zone in this list."
},
{
"field": "success_created_zone_count",
"type": "integer",
"description": "Number of items or occurrences"
},
{
"field": "valid_zone_list",
"type": "array",
"description": "Zones that we parsed successfully. On submission, objects will be created for every zone in this list."
}
]
}
]
},
	"dns-dns-zone-initiate-zone-transfer": {
"name": "dns-dns-zone-initiate-zone-transfer",
"displayName": "Dns Dns Zone Initiate Zone Transfer",
"operations": [
{
"name": "create_dns_dns_zone_initiate_zone_transfer",
"description": "Initiate Zone Transfer.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zone/initiate_zone_transfer",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Initiate Zone Transfer Request",
"x-displayname": "Initiate Zone Transfer Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.InitiateZoneTransferRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace is always system for dns_zone.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace is always system for dns_zone.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"zone_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Zone Name",
"x-displayname": "Zone Name",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_zoneInitiateZoneTransferRequest",
"required_fields": [
"zone_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_zoneInitiateZoneTransferRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  zone_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"zone_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"zone_name": "value"
}
},
"requiredFields": [
"zone_name"
],
"description": "Minimum configuration for dns_zoneInitiateZoneTransferRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace is always system for dns_zone.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"zone_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"dns-dns-zones-rrsets": {
"name": "dns-dns-zones-rrsets",
"displayName": "Dns Dns Zones Rrsets",
"operations": [
{
"name": "create_dns_dns_zones_rrset",
"description": "Create",
"method": "POST",
"path": "/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "group_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"title": "CreateRequest",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.rrset.CreateRequest",
"properties": {
"dns_zone_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "dns_zone_name",
"x-displayname": "DNS zone name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"group_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "group_name",
"minLength": 1,
"x-displayname": "Group name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset": {
"allOf": [
{
"$ref": "#/components/schemas/dns_zoneRRSet"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rrsetCreateRequest",
"required_fields": [
"dns_zone_name",
"group_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rrsetCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  dns_zone_name: value\n  group_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"dns_zone_name\": \"value\",\n    \"group_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"dns_zone_name": {
"type": "string"
},
"group_name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"record_name": {
"type": "string"
},
"type": {
"type": "string"
},
"resource_version": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"dns_zone_name": "value",
"group_name": "value"
}
},
"requiredFields": [
"dns_zone_name",
"group_name"
],
"description": "Minimum configuration for rrsetCreateRequest"
},
"fieldMetadata": {
"dns_zone_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"group_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.a_record": {
"type": "object",
"description": "A Records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.a_record.name": {
"type": "string",
"description": "A Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.a_record.values": {
"type": "array",
"description": "A valid IPv4 address, for example: 192.0.2.242.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.aaaa_record": {
"type": "object",
"description": "RecordSet for AAAA Records.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.aaaa_record.name": {
"type": "string",
"description": "AAAA Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.aaaa_record.values": {
"type": "array",
"description": "A valid IPv6 address, for example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.afsdb_record": {
"type": "object",
"description": "DNS AFSDB Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.afsdb_record.name": {
"type": "string",
"description": "AFSDB Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.afsdb_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.alias_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.alias_record.value": {
"type": "string",
"description": "A valid domain name, for example: example.com.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.caa_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.caa_record.name": {
"type": "string",
"description": "CAA Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.caa_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cds_record": {
"type": "object",
"description": "DNS CDS Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cds_record.name": {
"type": "string",
"description": "CDS Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cds_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.cert_record": {
"type": "object",
"description": "DNS CERT Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cert_record.name": {
"type": "string",
"description": "CERT Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cert_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.cname_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cname_record.name": {
"type": "string",
"description": "CName Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.cname_record.value": {
"type": "string",
"description": "Configuration parameter for value",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.description": {
"type": "string",
"description": "Human-readable description text",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ds_record": {
"type": "object",
"description": "DNS DS Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ds_record.name": {
"type": "string",
"description": "DS Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ds_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.eui48_record": {
"type": "object",
"description": "DNS EUI48 Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui48_record.name": {
"type": "string",
"description": "EUI48 Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui48_record.value": {
"type": "string",
"description": "A valid eui48 identifier, for example: 01-23-45-67-89-ab.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 17,
"maxLength": 17,
"pattern": "^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.eui64_record": {
"type": "object",
"description": "DNS EUI64 Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui64_record.name": {
"type": "string",
"description": "EUI64 Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui64_record.value": {
"type": "string",
"description": "A valid EUI64 identifier, for example: 01-23-45-67-89-ab-cd-ef.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 23,
"maxLength": 23,
"pattern": "^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.lb_record": {
"type": "object",
"description": "DNS Load Balancer Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.lb_record.name": {
"type": "string",
"description": "Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.lb_record.value": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.loc_record": {
"type": "object",
"description": "DNS LOC Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.loc_record.name": {
"type": "string",
"description": "LOC Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.loc_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.mx_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.mx_record.name": {
"type": "string",
"description": "MX Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.mx_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.naptr_record": {
"type": "object",
"description": "DNS NAPTR Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.naptr_record.name": {
"type": "string",
"description": "NAPTR Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.naptr_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.ns_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ns_record.name": {
"type": "string",
"description": "NS Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ns_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.ptr_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ptr_record.name": {
"type": "string",
"description": "PTR Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ptr_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.srv_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.srv_record.name": {
"type": "string",
"description": "SRV Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.srv_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.sshfp_record": {
"type": "object",
"description": "DNS SSHFP Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.sshfp_record.name": {
"type": "string",
"description": "SSHFP Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.sshfp_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.tlsa_record": {
"type": "object",
"description": "DNS TLSA Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.tlsa_record.name": {
"type": "string",
"description": "TLSA Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.tlsa_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.ttl": {
"type": "integer",
"description": "Time-to-live duration in seconds",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 60,
"maximum": 2147483647,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.txt_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.txt_record.name": {
"type": "string",
"description": "TXT Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.txt_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"rrset.type_record_set": [
"a_record",
"aaaa_record",
"afsdb_record",
"alias_record",
"caa_record",
"cds_record",
"cert_record",
"cname_record",
"ds_record",
"eui48_record",
"eui64_record",
"lb_record",
"loc_record",
"mx_record",
"naptr_record",
"ns_record",
"ptr_record",
"srv_record",
"sshfp_record",
"tlsa_record",
"txt_record"
]
},
"responseSummary": [
{
"field": "dns_zone_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "group_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "namespace",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "record_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "rrset",
"type": "object",
"description": ""
},
{
"field": "type",
"type": "string",
"description": "Type or category classification"
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
},
{
"name": "delete_dns_dns_zones_rrset",
"description": "DELETE",
"method": "DELETE",
"path": "/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type}",
      "dangerLevel": "high",
"parameters": [
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "group_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "record_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"dns_zone_name": {
"type": "string"
},
"group_name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"record_name": {
"type": "string"
},
"type": {
"type": "string"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "dns_zone_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "group_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "namespace",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "record_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "rrset",
"type": "object",
"description": ""
},
{
"field": "type",
"type": "string",
"description": "Type or category classification"
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
},
{
"name": "get_dns_dns_zones_rrset",
"description": "GET",
"method": "GET",
"path": "/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type}",
      "dangerLevel": "low",
"parameters": [
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "group_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "record_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"dns_zone_name": {
"type": "string"
},
"group_name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"record_name": {
"type": "string"
},
"type": {
"type": "string"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "dns_zone_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "group_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "namespace",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "record_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "rrset",
"type": "object",
"description": ""
},
{
"field": "type",
"type": "string",
"description": "Type or category classification"
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
},
{
"name": "replace_dns_dns_zones_rrset",
"description": "Replace",
"method": "PUT",
"path": "/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "group_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "record_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"title": "ReplaceRequest",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.rrset.ReplaceRequest",
"properties": {
"dns_zone_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "dns_zone_name",
"x-displayname": "DNS zone name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"group_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "group_name",
"minLength": 1,
"x-displayname": "Group name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"record_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "record_name",
"x-displayname": "Record name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset": {
"allOf": [
{
"$ref": "#/components/schemas/dns_zoneRRSet"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"type": {
"type": "string",
"description": "Type or category classification",
"title": "type",
"x-displayname": "Type",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"A\\\",\\\"AAAA\\\",\\\"ALIAS\\\",\\\"CAA\\\",\\\"CNAME\\\",\\\"MX\\\",\\\"NS\\\",\\\"PTR\\\",\\\"SRV\\\",\\\"TXT\\\",\\\"DNSLB\\\",\\\"NAPTR\\\",\\\"AFSDB\\\",\\\"EUI48\\\",\\\"EUI64\\\",\\\"DS\\\",\\\"CDS\\\",\\\"LOC\\\",\\\"SSHFP\\\",\\\"TLSA\\\",\\\"CERT\\\"]"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"A\\\",\\\"AAAA\\\",\\\"ALIAS\\\",\\\"CAA\\\",\\\"CNAME\\\",\\\"MX\\\",\\\"NS\\\",\\\"PTR\\\",\\\"SRV\\\",\\\"TXT\\\",\\\"DNSLB\\\",\\\"NAPTR\\\",\\\"AFSDB\\\",\\\"EUI48\\\",\\\"EUI64\\\",\\\"DS\\\",\\\"CDS\\\",\\\"LOC\\\",\\\"SSHFP\\\",\\\"TLSA\\\",\\\"CERT\\\"]"
},
"enum": [
"A",
"AAAA",
"ALIAS",
"CAA",
"CNAME",
"MX",
"NS",
"PTR",
"SRV",
"TXT",
"DNSLB",
"NAPTR",
"AFSDB",
"EUI48",
"EUI64",
"DS",
"CDS",
"LOC",
"SSHFP",
"TLSA",
"CERT"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"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 rrsetReplaceRequest",
"required_fields": [
"dns_zone_name",
"group_name",
"record_name",
"type"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rrsetReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  dns_zone_name: value\n  group_name: value\n  record_name: value\n  type: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"dns_zone_name\": \"value\",\n    \"group_name\": \"value\",\n    \"record_name\": \"value\",\n    \"type\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"dns_zone_name": {
"type": "string"
},
"group_name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"record_name": {
"type": "string"
},
"type": {
"type": "string"
},
"resource_version": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"dns_zone_name": "value",
"group_name": "value",
"record_name": "value",
"type": "value"
}
},
"requiredFields": [
"dns_zone_name",
"group_name",
"record_name",
"type"
],
"description": "Minimum configuration for rrsetReplaceRequest"
},
"fieldMetadata": {
"dns_zone_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "([0-9a-z]([.a-z0-9-]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"group_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"pattern": "([a-z]([-a-z0-9_]*[a-z0-9])?)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"record_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.a_record": {
"type": "object",
"description": "A Records",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.a_record.name": {
"type": "string",
"description": "A Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.a_record.values": {
"type": "array",
"description": "A valid IPv4 address, for example: 192.0.2.242.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.aaaa_record": {
"type": "object",
"description": "RecordSet for AAAA Records.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.aaaa_record.name": {
"type": "string",
"description": "AAAA Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.aaaa_record.values": {
"type": "array",
"description": "A valid IPv6 address, for example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.afsdb_record": {
"type": "object",
"description": "DNS AFSDB Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.afsdb_record.name": {
"type": "string",
"description": "AFSDB Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.afsdb_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.alias_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.alias_record.value": {
"type": "string",
"description": "A valid domain name, for example: example.com.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.caa_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.caa_record.name": {
"type": "string",
"description": "CAA Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.caa_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cds_record": {
"type": "object",
"description": "DNS CDS Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cds_record.name": {
"type": "string",
"description": "CDS Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cds_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.cert_record": {
"type": "object",
"description": "DNS CERT Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cert_record.name": {
"type": "string",
"description": "CERT Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cert_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.cname_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.cname_record.name": {
"type": "string",
"description": "CName Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.cname_record.value": {
"type": "string",
"description": "Configuration parameter for value",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.description": {
"type": "string",
"description": "Human-readable description text",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ds_record": {
"type": "object",
"description": "DNS DS Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ds_record.name": {
"type": "string",
"description": "DS Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ds_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.eui48_record": {
"type": "object",
"description": "DNS EUI48 Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui48_record.name": {
"type": "string",
"description": "EUI48 Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui48_record.value": {
"type": "string",
"description": "A valid eui48 identifier, for example: 01-23-45-67-89-ab.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 17,
"maxLength": 17,
"pattern": "^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.eui64_record": {
"type": "object",
"description": "DNS EUI64 Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui64_record.name": {
"type": "string",
"description": "EUI64 Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.eui64_record.value": {
"type": "string",
"description": "A valid EUI64 identifier, for example: 01-23-45-67-89-ab-cd-ef.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 23,
"maxLength": 23,
"pattern": "^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.lb_record": {
"type": "object",
"description": "DNS Load Balancer Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.lb_record.name": {
"type": "string",
"description": "Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.lb_record.value": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.loc_record": {
"type": "object",
"description": "DNS LOC Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.loc_record.name": {
"type": "string",
"description": "LOC Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.loc_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.mx_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.mx_record.name": {
"type": "string",
"description": "MX Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.mx_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.naptr_record": {
"type": "object",
"description": "DNS NAPTR Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.naptr_record.name": {
"type": "string",
"description": "NAPTR Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.naptr_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.ns_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ns_record.name": {
"type": "string",
"description": "NS Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ns_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.ptr_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ptr_record.name": {
"type": "string",
"description": "PTR Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.ptr_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.srv_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.srv_record.name": {
"type": "string",
"description": "SRV Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.srv_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.sshfp_record": {
"type": "object",
"description": "DNS SSHFP Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.sshfp_record.name": {
"type": "string",
"description": "SSHFP Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.sshfp_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.tlsa_record": {
"type": "object",
"description": "DNS TLSA Record.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.tlsa_record.name": {
"type": "string",
"description": "TLSA Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.tlsa_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.ttl": {
"type": "integer",
"description": "Time-to-live duration in seconds",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 60,
"maximum": 2147483647,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rrset.txt_record": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.txt_record.name": {
"type": "string",
"description": "TXT Record name, please provide only the specific subdomain or record name without the base domain.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 63,
"minLength": 1,
"pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rrset.txt_record.values": {
"type": "array",
"description": "Configuration parameter for values",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"type": {
"type": "string",
"description": "Type or category classification",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"rrset.type_record_set": [
"a_record",
"aaaa_record",
"afsdb_record",
"alias_record",
"caa_record",
"cds_record",
"cert_record",
"cname_record",
"ds_record",
"eui48_record",
"eui64_record",
"lb_record",
"loc_record",
"mx_record",
"naptr_record",
"ns_record",
"ptr_record",
"srv_record",
"sshfp_record",
"tlsa_record",
"txt_record"
]
},
"responseSummary": [
{
"field": "dns_zone_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "group_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "namespace",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "record_name",
"type": "string",
"description": "Human-readable name for the resource"
},
{
"field": "rrset",
"type": "object",
"description": ""
},
{
"field": "type",
"type": "string",
"description": "Type or category classification"
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dns-domains": {
"name": "dns-domains",
"displayName": "Dns Domains",
"operations": [
{
"name": "create_dns_domain",
"description": "Create DNS Domain.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/dns_domains",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of dns_domain",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.dns_domain.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/dns_domainCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_domainCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_domainCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_domainCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create DNS Domain in a given namespace. If one already exist it will give a error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dnssec_mode": {
"type": "string",
"description": "Enable or disable DNSSEC on the DNS Domain\n\nDNSSEC is disabled\nDNSSEC is enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DNSSEC_DISABLE"
},
"spec.volterra_managed": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.domain_choice": [
"volterra_managed"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_dns_domain",
"description": "Replace DNS Domain.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/dns_domains/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a dns_domain",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.dns_domain.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/dns_domainReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_domainReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_domainReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_domainReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace DNS Domain in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dnssec_mode": {
"type": "string",
"description": "Enable or disable DNSSEC on the DNS Domain\n\nDNSSEC is disabled\nDNSSEC is enabled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DNSSEC_DISABLE"
},
"spec.volterra_managed": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.domain_choice": [
"volterra_managed"
]
}
},
{
"name": "list_dns_domains",
"description": "List DNS Domain.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dns_domains",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_dns_domain",
"description": "DELETE DNS Domain.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/dns_domains/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a dns_domain",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.dns_domain.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_domainDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_domainDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
}
},
{
"name": "get_dns_domain",
"description": "GET DNS Domain.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dns_domains/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dns-lb-pools-health-status": {
"name": "dns-lb-pools-health-status",
"displayName": "Dns Lb Pools Health Status",
"operations": [
{
"name": "list_dns_lb_pools_health_status",
"description": "DNS Load Balancer Pool Health Status.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/dns_load_balancers/{dns_lb_name}/dns_lb_pools/{dns_lb_pool_name}/health_status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dns_lb_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "dns_lb_pool_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"dns_lb_pool_member_items": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "dns_lb_pool_member_items",
"type": "array",
"description": "Collection of DNS Load Balancer Pool Members."
},
{
"field": "status",
"type": "array",
"description": "Health Status of DNS Load Balancer Pool."
}
]
}
]
},
	"dns-lb-pools-pool-members-health-status-change-events": {
"name": "dns-lb-pools-pool-members-health-status-change-events",
"displayName": "Dns Lb Pools Pool Members Health Status Change Events",
"operations": [
{
"name": "list_dns_lb_pools_pool_members_health_status_change_events",
"description": "DNS Load Balancer Pool Member Health Status Change Events.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/dns_load_balancers/{dns_lb_name}/dns_lb_pools/{dns_lb_pool_name}/pool_members/{pool_member_address}/health_status_change_events",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dns_lb_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "dns_lb_pool_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pool_member_address",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"dns_lb_pool_member_events": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "dns_lb_pool_member_events",
"type": "array",
"description": "Collection of DNS Load Balancer Pool Members."
}
]
}
]
},
	"dns-local-zone-file": {
"name": "dns-local-zone-file",
"displayName": "Dns Local Zone File",
"operations": [
{
"name": "list_dns_local_zone_file",
"description": "GET Local Zone File.",
"method": "GET",
"path": "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/local_zone_file",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"last_axfr_timestamp": {
"type": "string"
},
"zone_file": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "last_axfr_timestamp",
"type": "string",
"description": "Last successful zone transfer timestamp."
},
{
"field": "zone_file",
"type": "string",
"description": "Local zone file."
}
]
}
]
},
	"dns-local-zone-record-names": {
"name": "dns-local-zone-record-names",
"displayName": "Dns Local Zone Record Names",
"operations": [
{
"name": "list_dns_local_zone_record_names",
"description": "GET Local Zone Record Names.",
"method": "GET",
"path": "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/local_zone_record_names",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"record_names": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "record_names",
"type": "array",
"description": "Unique record names parsed from the local zone file."
}
]
}
]
},
	"dns-proxys": {
"name": "dns-proxys",
"displayName": "Dns Proxys",
"operations": [
{
"name": "create_dns_proxy",
"description": "Create DNS Proxy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/dns_proxys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of dns_proxy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.dns_proxy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemadns_proxyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_proxyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_proxyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_proxyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create DNS Proxy in a given namespace. If one already exists it will give an error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_profile": {
"type": "object",
"description": "DNS Cache specifies cache configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_profile.cache_size": {
"type": "integer",
"description": "Exclusive with [disable_cache_profile]\ncache size.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 10240,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_profile.disable_cache_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile": {
"type": "object",
"description": "DDoS Protection Rule for DNS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.disable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.enable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules": {
"type": "array",
"description": "OPTIONS for attaching iRules to DNS proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm": {
"type": "object",
"description": "Load Balancing Algorithm Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm.round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers": {
"type": "object",
"description": "List of origin Servers for the DNS proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers.health_checks": {
"type": "object",
"description": "Origin Server Health Checks.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers.origin_servers": {
"type": "array",
"description": "List of origin servers for Proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_inspection": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_inspection.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_inspection.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_inspection.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement": {
"type": "object",
"description": "Proxy Advertisement Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.transport_type": {
"type": "string",
"description": "Transport Type\n\n- UDP: UDP\n\n- TCP: TCP\n\n- BothTCPAndUDP: Both TCP and UDP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UDP"
}
},
"oneOfVariants": {
"spec.cache_profile.cache_profile_choice": [
"cache_size",
"disable_cache_profile"
],
"spec.ddos_profile.ddos_mitigation_choice": [
"disable_ddos_mitigation",
"enable_ddos_mitigation"
],
"spec.lb_algorithm.lb_algorithm_choice": [
"round_robin"
],
"spec.proxy_advertisement.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_dns_proxy",
"description": "Replace DNS Proxy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/dns_proxys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a dns_proxy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.dns_proxy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemadns_proxyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_proxyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_proxyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_proxyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace DNS Proxy in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_profile": {
"type": "object",
"description": "DNS Cache specifies cache configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_profile.cache_size": {
"type": "integer",
"description": "Exclusive with [disable_cache_profile]\ncache size.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 10240,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cache_profile.disable_cache_profile": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile": {
"type": "object",
"description": "DDoS Protection Rule for DNS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.disable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_profile.enable_ddos_mitigation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.irules": {
"type": "array",
"description": "OPTIONS for attaching iRules to DNS proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm": {
"type": "object",
"description": "Load Balancing Algorithm Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_algorithm.round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers": {
"type": "object",
"description": "List of origin Servers for the DNS proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers.health_checks": {
"type": "object",
"description": "Origin Server Health Checks.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers.origin_servers": {
"type": "array",
"description": "List of origin servers for Proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_inspection": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_inspection.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_inspection.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_inspection.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement": {
"type": "object",
"description": "Proxy Advertisement Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_advertisement.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.transport_type": {
"type": "string",
"description": "Transport Type\n\n- UDP: UDP\n\n- TCP: TCP\n\n- BothTCPAndUDP: Both TCP and UDP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UDP"
}
},
"oneOfVariants": {
"spec.cache_profile.cache_profile_choice": [
"cache_size",
"disable_cache_profile"
],
"spec.ddos_profile.ddos_mitigation_choice": [
"disable_ddos_mitigation",
"enable_ddos_mitigation"
],
"spec.lb_algorithm.lb_algorithm_choice": [
"round_robin"
],
"spec.proxy_advertisement.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
]
}
},
{
"name": "list_dns_proxys",
"description": "List Configure DNS Proxy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dns_proxys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_dns_proxy",
"description": "DELETE Configure DNS Proxy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/dns_proxys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a dns_proxy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.dns_proxy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_proxyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_proxyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
}
},
{
"name": "get_dns_proxy",
"description": "GET DNS Proxy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/dns_proxys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"dns-remote-zone-file": {
"name": "dns-remote-zone-file",
"displayName": "Dns Remote Zone File",
"operations": [
{
"name": "list_dns_remote_zone_file",
"description": "GET Remote Zone File.",
"method": "GET",
"path": "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/remote_zone_file",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"zone_file": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "zone_file",
"type": "string",
"description": "Remote zone file."
}
]
}
]
},
	"dns-suggest-values": {
"name": "dns-suggest-values",
"displayName": "Dns Suggest Values",
"operations": [
{
"name": "create_dns_suggest_value",
"description": "Suggest Values.",
"method": "POST",
"path": "/api/config/dns/namespaces/system/suggest-values",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of SuggestValues request.",
"title": "SuggestValuesReq",
"x-displayname": "Request for SuggestValues.",
"x-ves-proto-message": "ves.io.schema.dns_load_balancer.SuggestValuesReq",
"properties": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"title": "field_path",
"maxLength": 1024,
"x-displayname": "Field Path.",
"x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match",
      "x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"title": "match_value",
"maxLength": 256,
"x-displayname": "Match Value.",
"x-ves-example": "Some-substring.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "some-substring",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"request_body": {
"allOf": [
{
"$ref": "#/components/schemas/protobufAny"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_load_balancerSuggestValuesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_load_balancerSuggestValuesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_load_balancerSuggestValuesReq"
},
"fieldMetadata": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body": {
"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\": <string>,\n\"lastName\": <string>\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}",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.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.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.value": {
"type": "string",
"description": "Must be a valid serialized protocol buffer of the above specified type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of suggested items."
}
]
}
]
},
	"dns-zone-file-export": {
"name": "dns-zone-file-export",
"displayName": "Dns Zone File Export",
"operations": [
{
"name": "list_dns_zone_file_export",
"description": "Export Zone File.",
"method": "GET",
"path": "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/zone_file/export",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dns_zone_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"html_data": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "html_data",
"type": "string",
"description": "Base64-encoded zone file."
}
]
}
]
},
	"dos-automitigation-rules": {
"name": "dos-automitigation-rules",
"displayName": "Dos Automitigation Rules",
"operations": [
{
"name": "list_dos_automitigation_rules",
"description": "GET DoS Auto-Mitigation Rules for CDN Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/dos_automitigation_rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"dos_automitigation_rules": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "dos_automitigation_rules",
"type": "array",
"description": "Rule or policy definition"
}
]
},
{
"name": "delete_dos_automitigation_rule",
"description": "DELETE DoS Auto-Mitigation Rule for CDN Load Balancer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/dos_automitigation_rules/{dos_automitigation_rule_name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "dos_automitigation_rule_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "name",
"type": "string",
"description": "Name of the deleted DoS Auto-Mitigation loadbalancer Rule."
}
]
}
]
},
	"download-certificates": {
"name": "download-certificates",
"displayName": "Download Certificates",
"operations": [
{
"name": "create_download_certificate",
"description": "Download Certificates.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/discovery/{name}/download_certificates",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Download Certificates Of Log Collector.",
"title": "DownloadCertificatesRequest",
"x-displayname": "Download Certificates.",
"x-ves-proto-message": "ves.io.schema.discovery.DownloadCertificatesRequest",
"properties": {
"name": {
"type": "string",
"description": "Identifies the discovery name.",
"title": "Discovery Name",
"x-displayname": "Discovery Name.",
"x-ves-example": "Ds1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ds1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for discoveryDownloadCertificatesRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for discoveryDownloadCertificatesRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for discoveryDownloadCertificatesRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Identifies the discovery name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the discovered service for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "string",
"description": "Data is base64 encoded value of certificate in PKCS12 format."
}
]
}
]
},
	"dynamic-data": {
"name": "dynamic-data",
"displayName": "Dynamic Data",
"operations": [
{
"name": "create_dynamic_data",
"description": "Dynamic Data.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/dynamic-data",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request body of DynamicData request.",
"title": "DynamicDataReq",
"x-displayname": "Request for DynamicData.",
"x-ves-proto-message": "ves.io.schema.namespace.DynamicDataReq",
"properties": {
"defaults": {
"type": "boolean",
"description": "The response should contain the default values for a new object.",
"title": "defaults",
"format": "boolean",
"x-displayname": "Request Defaults.",
"x-f5xc-description-short": "The response should contain the default values for a new object.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_path": {
"type": "string",
"description": "JSON path of the field for which the data are being requested.",
"title": "field_path",
"maxLength": 1024,
"x-displayname": "Field Path.",
"x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match",
      "x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "JSON path of the field for which the data are being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the data is scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-f5xc-example": "example-resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"request_body": {
"allOf": [
{
"$ref": "#/components/schemas/protobufAny"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceDynamicDataReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceDynamicDataReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"rows": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceDynamicDataReq"
},
"fieldMetadata": {
"defaults": {
"type": "boolean",
"description": "The response should contain the default values for a new object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_path": {
"type": "string",
"description": "JSON path of the field for which the data are being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the data is scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body": {
"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\": <string>,\n\"lastName\": <string>\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}",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.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.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.value": {
"type": "string",
"description": "Must be a valid serialized protocol buffer of the above specified type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "rows",
"type": "array",
"description": "List of rows of data."
}
]
}
]
},
	"edge-credentials": {
"name": "edge-credentials",
      "displayName": "Edge Credentials",
      "operations": [
{
"name": "create_edge_credential",
      "description": "Cloud Credential.",
      "method": "POST",
"path": "/api/config/namespaces/system/edge_credentials",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to return all the credentials for the matching cloud site type.",
      "title": "CredentialsRequest",
      "x-displayname": "Edge Credentials Request.",
      "x-ves-proto-message": "ves.io.schema.cloud_connect.CredentialsRequest",
      "properties": {
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/cloud_connectCloudConnectProviderType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to return all the credentials for the matching cloud site type.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectCredentialsRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectCredentialsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {
"cred": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectCredentialsRequest"
      },
"fieldMetadata": {
"provider": {
"type": "string",
"description": "Cloud Connect Provider Type\n\n- AWS: AWS\n\nCloud connects backed by AWS cloud\n- Azure: Azure\n\nCloud connects backed by Azure cloud\n- GCP: GCP\n\nCloud connects backed by GCP cloud.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AWS"
}
},
"responseSummary": [
{
"field": "cred",
"type": "array",
"description": "Cloud credentials."
      }
]
}
]
},
	"edge-list": {
"name": "edge-list",
"displayName": "Edge List",
"operations": [
{
"name": "list_edge_list",
"description": "Edge List",
"method": "GET",
"path": "/api/config/namespaces/system/edge_list",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"edge_site": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "edge_site",
"type": "array",
"description": "Reference to a edge site."
}
]
}
]
},
	"endpoints": {
"name": "endpoints",
"displayName": "Endpoints",
"operations": [
{
"name": "create_endpoint",
"description": "Create Endpoint.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of endpoint",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.endpoint.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/schemaendpointCreateSpecType"
}
],
"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 endpointCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for endpointCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for endpointCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create endpoint will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name": {
"type": "string",
"description": "Exclusive with [dns_name_advanced IP service_info]\nEndpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"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])?$",
"characterSet": {
"allowed": "[a-z0-9.-]",
"description": "Dot-separated DNS labels"
},
"format": "hostname",
"formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name_advanced": {
"type": "object",
"description": "Specifies name and TTL used for DNS resolution.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name_advanced.name": {
"type": "string",
"description": "Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "hostname",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name_advanced.refresh_interval": {
"type": "integer",
"description": "Exclusive with []\nInterval for DNS refresh in seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 604800,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_check_port": {
"type": "integer",
"description": "By default the health check port of an endpoint is the same as the endpoint’s port. This option provides an alternative health check port.\nSetting this with a non-zero value allows an endpoint to have different health check port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip": {
"type": "string",
"description": "Exclusive with [dns_name dns_name_advanced service_info]\nEndpoint is reachable at the given IPv4/IPv6 address.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Endpoint service is available on this port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Endpoint protocol. Default is TCP.\nBoth TCP and UDP protocols are supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_info": {
"type": "object",
"description": "Specifies whether endpoint service is discovered by name or labels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_info.discovery_type": {
"type": "string",
"description": "Specifies the type of discovery\n\nInvalid Discovery mechanism\nDiscover from Kubernetes cluster\nDiscover from Consul service\nDiscover from Classic BIG-IP Clusters\nDiscover for Third Party Application\nDiscover from NGINX One.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INVALID_DISCOVERY"
},
"spec.service_info.service_name": {
"type": "string",
"description": "Exclusive with [service_selector]\nName of the service to discover with an optional namespace and cluster identifier.\nThe format is service_name.namespace_name:cluster_identifier for K8s and\nservice_name:cluster_identifier for Consul\nEndpoint will be discovered in all discovery objects where the cluster identifier matches.\nIf cluster identifier is not specified then discovery will be done in all\ndiscovery objects of the site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_info.service_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.snat_pool": {
"type": "object",
"description": "SNAT Pool configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.snat_pool.no_snat_pool": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.snat_pool.snat_pool": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.endpoint_address": [
"dns_name",
"dns_name_advanced",
"ip",
"service_info"
],
"spec.dns_name_advanced.ttl_choice": [
"refresh_interval"
],
"spec.service_info.service_info": [
"service_name",
"service_selector"
],
"spec.snat_pool.snat_pool_choice": [
"no_snat_pool",
"snat_pool"
],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_endpoint",
"description": "Replace Endpoint.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/endpoints/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a endpoint",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.endpoint.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/schemaendpointReplaceSpecType"
}
],
"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 endpointReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for endpointReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for endpointReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name": {
"type": "string",
"description": "Exclusive with [dns_name_advanced IP service_info]\nEndpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"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])?$",
"characterSet": {
"allowed": "[a-z0-9.-]",
"description": "Dot-separated DNS labels"
},
"format": "hostname",
"formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name_advanced": {
"type": "object",
"description": "Specifies name and TTL used for DNS resolution.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name_advanced.name": {
"type": "string",
"description": "Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "hostname",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_name_advanced.refresh_interval": {
"type": "integer",
"description": "Exclusive with []\nInterval for DNS refresh in seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 604800,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_check_port": {
"type": "integer",
"description": "By default the health check port of an endpoint is the same as the endpoint’s port. This option provides an alternative health check port.\nSetting this with a non-zero value allows an endpoint to have different health check port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip": {
"type": "string",
"description": "Exclusive with [dns_name dns_name_advanced service_info]\nEndpoint is reachable at the given IPv4/IPv6 address.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Endpoint service is available on this port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Endpoint protocol. Default is TCP.\nBoth TCP and UDP protocols are supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_info": {
"type": "object",
"description": "Specifies whether endpoint service is discovered by name or labels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_info.discovery_type": {
"type": "string",
"description": "Specifies the type of discovery\n\nInvalid Discovery mechanism\nDiscover from Kubernetes cluster\nDiscover from Consul service\nDiscover from Classic BIG-IP Clusters\nDiscover for Third Party Application\nDiscover from NGINX One.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INVALID_DISCOVERY"
},
"spec.service_info.service_name": {
"type": "string",
"description": "Exclusive with [service_selector]\nName of the service to discover with an optional namespace and cluster identifier.\nThe format is service_name.namespace_name:cluster_identifier for K8s and\nservice_name:cluster_identifier for Consul\nEndpoint will be discovered in all discovery objects where the cluster identifier matches.\nIf cluster identifier is not specified then discovery will be done in all\ndiscovery objects of the site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_info.service_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.snat_pool": {
"type": "object",
"description": "SNAT Pool configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.snat_pool.no_snat_pool": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.snat_pool.snat_pool": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.endpoint_address": [
"dns_name",
"dns_name_advanced",
"ip",
"service_info"
],
"spec.dns_name_advanced.ttl_choice": [
"refresh_interval"
],
"spec.service_info.service_info": [
"service_name",
"service_selector"
],
"spec.snat_pool.snat_pool_choice": [
"no_snat_pool",
"snat_pool"
],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
}
},
{
"name": "list_endpoints",
"description": "List Endpoint.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/endpoints",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_endpoint",
"description": "DELETE Endpoint.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/endpoints/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a endpoint",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.endpoint.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for endpointDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for endpointDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_endpoint",
"description": "GET Endpoint.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/endpoints/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"enhanced-firewall-policys": {
"name": "enhanced-firewall-policys",
"displayName": "Enhanced Firewall Policys",
"operations": [
{
"name": "create_enhanced_firewall_policy",
"description": "Create Enhanced Firewall Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/enhanced_firewall_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of enhanced_firewall_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.enhanced_firewall_policy.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/schemaenhanced_firewall_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Enhanced L4 firewall policy with segment-based access control",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-efp\n  namespace: default\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-efp\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-efp",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Enhanced L4 firewall policy with segment-based access control"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of Enhanced Firewall Policy specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_destinations": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_destinations.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_sources": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_sources.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_destinations": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_destinations.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_sources": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_sources.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list": {
"type": "object",
"description": "Custom Enhanced Firewall Policy Rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list.rules": {
"type": "array",
"description": "Ordered List of Enhanced Firewall Policy Rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.rule_choice": [
"allow_all",
"allowed_destinations",
"allowed_sources",
"denied_destinations",
"denied_sources",
"deny_all",
"rule_list"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_enhanced_firewall_policy",
"description": "Replace Enhanced Firewall Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/enhanced_firewall_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a enhanced_firewall_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.enhanced_firewall_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemaenhanced_firewall_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Enhanced L4 firewall policy with segment-based access control",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-efp\n  namespace: default\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-efp\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-efp",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Enhanced L4 firewall policy with segment-based access control"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of Enhanced Firewall Policy replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_destinations": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_destinations.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_sources": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_sources.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_destinations": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_destinations.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_sources": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.denied_sources.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list": {
"type": "object",
"description": "Custom Enhanced Firewall Policy Rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list.rules": {
"type": "array",
"description": "Ordered List of Enhanced Firewall Policy Rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.rule_choice": [
"allow_all",
"allowed_destinations",
"allowed_sources",
"denied_destinations",
"denied_sources",
"deny_all",
"rule_list"
]
}
},
{
"name": "list_enhanced_firewall_policys",
"description": "List Enhanced Firewall Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/enhanced_firewall_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_enhanced_firewall_policy",
"description": "DELETE Enhanced Firewall Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/enhanced_firewall_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a enhanced_firewall_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.enhanced_firewall_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for enhanced_firewall_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for enhanced_firewall_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_enhanced_firewall_policy",
"description": "GET Enhanced Firewall Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/enhanced_firewall_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"escalate": {
"name": "escalate",
"displayName": "Escalate",
"operations": [
{
"name": "create_escalate",
"description": "Escalate a ticket.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/customer_support/{name}/escalate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Changes priority of an existing customer support ticket.",
"title": "Request to escalate a ticket",
"x-displayname": "Customer support ticket change priority request.",
"x-ves-proto-message": "ves.io.schema.customer_support.EscalationRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be escalated.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the customer support ticket object to be escalated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present in.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the support ticket object is present in.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Changes priority of an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportEscalationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportEscalationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportEscalationRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be escalated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present in.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"evaluate": {
"name": "evaluate",
"displayName": "Evaluate",
"operations": [
{
"name": "create_evaluate",
"description": "Evaluate API Group.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/app_api_groups/evaluate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for Evaluate API Group.",
      "title": "Evaluate API Group Request",
      "x-displayname": "Evaluate API Group Request.",
      "x-ves-proto-message": "ves.io.schema.views.app_api_group.EvaluateApiGroupReq",
      "properties": {
"api_group": {
      "allOf": [
{
"$ref": "#/components/schemas/viewsapp_api_groupGlobalSpecType"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the API Group for the current request.",
      "title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the API Group for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_api_groupEvaluateApiGroupReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_api_groupEvaluateApiGroupReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"apieps_timestamp": {
      "type": "string"
},
"matching_api_endpoints": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_api_groupEvaluateApiGroupReq"
      },
"fieldMetadata": {
"api_group": {
      "type": "object",
"description": "Shape of app_api_group in the storage backend.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.api_endpoints_count": {
      "type": "integer",
"description": "Number of API Endpoints in the actual API Group.\nIf the lists included, matched, excluded are disjoint then the length is\nlen(included) + len(matched) - excluded.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.bigip_virtual_server": {
      "type": "object",
"description": "Set the scope of the API Group to a specific BIG-IP Virtual Server.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.bigip_virtual_server.bigip_virtual_server": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.cdn_loadbalancer": {
      "type": "object",
"description": "Set the scope of the API Group to a specific CDN Loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.cdn_loadbalancer.cdn_loadbalancer": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.elements": {
      "type": "array",
"description": "List of API group elements with methods and path regex for matching requests.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5000,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"api_group.http_loadbalancer": {
      "type": "object",
"description": "Set the scope of the API Group to a specific HTTP Loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_group.http_loadbalancer.http_loadbalancer": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the API Group for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"api_group.scope_choice": [
      "bigip_virtual_server",
"cdn_loadbalancer",
"http_loadbalancer"
]
},
"responseSummary": [
{
"field": "api_group",
      "type": "object",
"description": ""
},
{
"field": "apieps_timestamp",
      "type": "string",
"description": "The API endpoints timestamp indicates when the most recent update of API endpoints happened\nFor example, if the referenced object is HTTP LB then the API Discovery periodically updates\nthe API endpoints list based on application's traffic."
      },
{
"field": "matching_api_endpoints",
      "type": "array",
"description": "List of API Endpoints matched by the query expression.\nThe paths appear here with parameters as defined in OpenAPI spec file."
      }
]
}
]
},
	"evaluate-api-access": {
"name": "evaluate-api-access",
      "displayName": "Evaluate Api Access",
      "operations": [
{
"name": "create_evaluate_api_acce",
      "description": "Evaluate API Access.",
      "method": "POST",
"path": "/api/web/namespaces/system/evaluate-api-access",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of Evaluate API Access.",
      "title": "EvaluateAPIAccessReq",
      "x-displayname": "Evaluate API Access Req.",
      "x-ves-proto-message": "ves.io.schema.namespace.EvaluateAPIAccessReq",
      "properties": {
"access_control_type": {
      "allOf": [
{
"$ref": "#/components/schemas/namespaceAccessControlType"
      }
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"item_lists": {
"type": "array",
"description": "A list of request API item lists.",
      "title": "item_lists",
"maxItems": 1000,
"items": {
"$ref": "#/components/schemas/namespaceAPIItemListReq"
      },
"x-displayname": "Item Lists.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "1000"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "1000"
},
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1000,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Name of the namespace under which all the URLs in APIItems will be evaluated.",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the namespace under which all the URLs in APIItems will be evaluated.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceEvaluateAPIAccessReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceEvaluateAPIAccessReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"item_lists": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceEvaluateAPIAccessReq"
      },
"fieldMetadata": {
"access_control_type": {
      "type": "string",
"description": "Enum consists of different access control types.\n\n- RBAC: RBAC\n\nDefault access control, evaluates role based access control.\n- PBAC: PBAC\n\nEvaluates plan based access control\n- ALL: ALL\n\nEvaluates all access controls specified in this enum.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "RBAC"
},
"item_lists": {
"type": "array",
"description": "A list of request API item lists.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1000,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Name of the namespace under which all the URLs in APIItems will be evaluated.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "item_lists",
"type": "array",
"description": "A list of request API item lists."
      }
]
}
]
},
	"evaluate-batch-api-access": {
"name": "evaluate-batch-api-access",
      "displayName": "Evaluate Batch Api Access",
      "operations": [
{
"name": "create_evaluate_batch_api_acce",
      "description": "Evaluate Batch API Access.",
      "method": "POST",
"path": "/api/web/namespaces/system/evaluate-batch-api-access",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of Evaluate Batch API Access.",
      "title": "EvaluateBatchAPIAccessReq",
      "x-displayname": "Evaluate Batch API Access Req.",
      "x-ves-proto-message": "ves.io.schema.namespace.EvaluateBatchAPIAccessReq",
      "properties": {
"batch_namespace_api_list": {
      "type": "array",
"description": "List of namespaces and associated API list entries.",
      "title": "batch_namespace_api_list",
      "maxItems": 75,
"items": {
"$ref": "#/components/schemas/namespaceNamespaceAPIListReq"
      },
"x-displayname": "Batch Namespace API List.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "75"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "75"
},
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "List of namespaces and associated API list entries.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 75,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request body of Evaluate Batch API Access.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceEvaluateBatchAPIAccessReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceEvaluateBatchAPIAccessReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"batch_namespace_api_list": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceEvaluateBatchAPIAccessReq"
      },
"fieldMetadata": {
"batch_namespace_api_list": {
      "type": "array",
"description": "List of namespaces and associated API list entries.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 75,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "batch_namespace_api_list",
      "type": "array",
"description": "List of namespaces and associated API list entries."
      }
]
}
]
},
	"events": {
"name": "events",
"displayName": "Events",
"operations": [
{
"name": "create_event",
"description": "Security Events Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch security events.",
"title": "Security Events Request",
"x-displayname": "Security Events Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityEventsRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the security events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated...",
"x-f5xc-description-medium": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of security events returned in the response\nOptional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of security events returned in the response Optional: If not specified, first or last 500 security events that matches the query...",
"x-f5xc-description-medium": "Limits the number of security events returned in the response Optional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={app_type=\"blogging_app\"}",
"x-f5xc-example": "\"query={app_type=\"blogging_app\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the security event may be specified in the query. Vh_name - name of the virtual host src_site - source site city ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of security events (or all security events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of security events until there are no more security events left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of security events (or all security events) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of security events (or all security events) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of security events until there are no more security events left to return. The...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"title": "sort by",
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: default is sort by last_event_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/app_securitySearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityEventsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityEventsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"events": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityEventsRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of security events returned in the response\nOptional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of security events (or all security events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of security events until there are no more security events left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "events",
"type": "array",
"description": "List of security events that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security events using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityEventsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"events-aggregation": {
"name": "events-aggregation",
"displayName": "Events Aggregation",
"operations": [
{
"name": "create_events_aggregation",
"description": "Security Events Aggregation Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/events/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for security events.",
"title": "Security Events Aggregation Request",
"x-displayname": "Security Events Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityEventsAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the security events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated...",
"x-f5xc-description-medium": "Fetch security events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={app_type=\"blogging_app\"}",
"x-f5xc-example": "\"query={app_type=\"blogging_app\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the security event may be specified in the query. Vh_name - name of the virtual host src_site - source site city ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch security events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for security events.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityEventsAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityEventsAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityEventsAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security events for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"events-scroll": {
"name": "events-scroll",
"displayName": "Events Scroll",
"operations": [
{
"name": "list_events_scroll",
"description": "Security Event Scroll Query.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/app_security/events/scroll",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "scroll_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"events": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "events",
"type": "array",
"description": "List of security events that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security events using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityEventsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
},
{
"name": "create_events_scroll",
"description": "Security Event Scroll Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/events/scroll",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Scroll request is used to fetch large number of security events in multiple batches with each SecurityEventsResponse\ncontaining no more than 500 messages. To scroll through more than 500 or all WAF security events, one can use the\nSecurityEventScrollRequest. Use the scroll_id returned in the SecurityEventsResponse to fetch the next batch of security events and\none can continue this process till the scroll_id returned is \"\" which indicates no more messages to scroll.",
"title": "Security Events Scroll Request",
"x-displayname": "Security Events Scroll Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityEventsScrollRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Fetch the WAF security events scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch the WAF security events scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"title": "scroll id",
"x-displayname": "Scroll ID",
"x-ves-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==.",
"x-f5xc-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Scroll request is used to fetch large number of security events in multiple batches with each SecurityEventsResponse containing no more than 500...",
"x-f5xc-description-medium": "Scroll request is used to fetch large number of security events in multiple batches with each SecurityEventsResponse containing no more than 500 messages. To scroll through more than 500 or all WAF security events, one can use the SecurityEventScrollRequest. Use the scroll_id returned in the...",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityEventsScrollRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityEventsScrollRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"events": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityEventsScrollRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Fetch the WAF security events scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "events",
"type": "array",
"description": "List of security events that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security events using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityEventsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"external-connectors": {
"name": "external-connectors",
"displayName": "External Connectors",
"operations": [
{
"name": "create_external_connector",
"description": "Create external_connector configuration.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/external_connectors",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of external_connector",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.external_connector.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/external_connectorCreateSpecType"
}
],
"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 external_connectorCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for external_connectorCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for external_connectorCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the external_connector configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ce_site_reference": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ce_site_reference.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ce_site_reference.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ce_site_reference.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gre": {
"type": "object",
"description": "External Connector with GRE tunnel.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gre.gre_parameters": {
"type": "object",
"description": "GRE configuration parameters required for GRE Connection type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipsec": {
"type": "object",
"description": "External Connector with IPsec tunnel.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipsec.ike_parameters": {
"type": "object",
"description": "IKE configuration parameters required for IPsec Connection type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipsec.ipsec_tunnel_parameters": {
"type": "object",
"description": "In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.connection_type": [
"gre",
"ipsec"
],
"spec.gre.gre_parameters.tunnel_source_vn": [
"segment",
"site_local_inside_network",
"site_local_network"
],
"spec.ipsec.ike_parameters.dpd_choice": [
"dpd_disabled",
"dpd_keep_alive_timer"
],
"spec.ipsec.ike_parameters.local_ike_id": [
"use_default_local_ike_id"
],
"spec.ipsec.ike_parameters.mode_choice": [
"initiator",
"responder"
],
"spec.ipsec.ike_parameters.remote_ike_id": [
"rm_hostname",
"rm_ip_address",
"use_default_remote_ike_id"
],
"spec.ipsec.ipsec_tunnel_parameters.tunnel_source_vn": [
"segment",
"site_local_inside_network",
"site_local_network"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_external_connector",
"description": "Replace external_connector configuration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/external_connectors/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a external_connector",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.external_connector.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/external_connectorReplaceSpecType"
}
],
"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 external_connectorReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for external_connectorReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for external_connectorReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the external_connector configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ce_site_reference": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ce_site_reference.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ce_site_reference.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ce_site_reference.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gre": {
"type": "object",
"description": "External Connector with GRE tunnel.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gre.gre_parameters": {
"type": "object",
"description": "GRE configuration parameters required for GRE Connection type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipsec": {
"type": "object",
"description": "External Connector with IPsec tunnel.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipsec.ike_parameters": {
"type": "object",
"description": "IKE configuration parameters required for IPsec Connection type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipsec.ipsec_tunnel_parameters": {
"type": "object",
"description": "In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.connection_type": [
"gre",
"ipsec"
],
"spec.gre.gre_parameters.tunnel_source_vn": [
"segment",
"site_local_inside_network",
"site_local_network"
],
"spec.ipsec.ike_parameters.dpd_choice": [
"dpd_disabled",
"dpd_keep_alive_timer"
],
"spec.ipsec.ike_parameters.local_ike_id": [
"use_default_local_ike_id"
],
"spec.ipsec.ike_parameters.mode_choice": [
"initiator",
"responder"
],
"spec.ipsec.ike_parameters.remote_ike_id": [
"rm_hostname",
"rm_ip_address",
"use_default_remote_ike_id"
],
"spec.ipsec.ipsec_tunnel_parameters.tunnel_source_vn": [
"segment",
"site_local_inside_network",
"site_local_network"
]
}
},
{
"name": "list_external_connectors",
"description": "List External Connector Configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/external_connectors",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_external_connector",
"description": "DELETE External Connector Configuration.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/external_connectors/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a external_connector",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.external_connector.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for external_connectorDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for external_connectorDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_external_connector",
"description": "GET external_connector configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/external_connectors/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"fast-acl-rules": {
"name": "fast-acl-rules",
"displayName": "Fast Acl Rules",
"operations": [
{
"name": "create_fast_acl_rule",
"description": "Create Fast ACL Rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/fast_acl_rules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of fast_acl_rule",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.fast_acl_rule.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/fast_acl_ruleCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Fast ACL for IP-based access control at network edge",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "site_choice",
"fields": [
"spec.re_acl",
"spec.site_acl"
],
"reason": "REQUIRED: Choose RE ACL (applies to Regional Edge) or Site ACL (applies to specific site)"
}
],
"example_yaml": "apiVersion: v1\nkind: fast_acl\nmetadata:\n  name: example-fast-acl\n  namespace: system\nspec:\n  re_acl: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-fast-acl\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"re_acl\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-fast-acl",
"namespace": "system"
},
"spec": {
"re_acl": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Fast ACL for IP-based access control at network edge"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a new Fast ACL rule, `fast_acl_rule` has specification to match source IP, source port and action to apply.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action": {
"type": "object",
"description": "FastAclRuleAction specifies possible action to be applied on traffic,\npossible action include dropping, forwarding or ratelimiting the traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action.policer_action": {
"type": "object",
"description": "Reference to policer object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action.protocol_policer_action": {
"type": "object",
"description": "Reference to policer object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action.simple_action": {
"type": "string",
"description": "FastAclRuleSimpleAction specifies simple action like PASS or DENY\n\nDrop the traffic\nForward the traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.ip_prefix_set": {
"type": "object",
"description": "A list of references to ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_set.ref": {
"type": "array",
"description": "A list of references to ip_prefix_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "array",
"description": "L4 port numbers to match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.prefix": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.source": [
"ip_prefix_set",
"prefix"
],
"spec.action.action": [
"policer_action",
"protocol_policer_action",
"simple_action"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_fast_acl_rule",
"description": "Replace Fast ACL Rule.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/fast_acl_rules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a fast_acl_rule",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.fast_acl_rule.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/fast_acl_ruleReplaceSpecType"
}
],
"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": "Fast ACL for IP-based access control at network edge",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "site_choice",
"fields": [
"spec.re_acl",
"spec.site_acl"
],
"reason": "REQUIRED: Choose RE ACL (applies to Regional Edge) or Site ACL (applies to specific site)"
}
],
"example_yaml": "apiVersion: v1\nkind: fast_acl\nmetadata:\n  name: example-fast-acl\n  namespace: system\nspec:\n  re_acl: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-fast-acl\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"re_acl\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-fast-acl",
"namespace": "system"
},
"spec": {
"re_acl": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Fast ACL for IP-based access control at network edge"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a given Fast ACL rule, `fast_acl_rule` has specification to match source IP, source port, protocol and action to apply.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action": {
"type": "object",
"description": "FastAclRuleAction specifies possible action to be applied on traffic,\npossible action include dropping, forwarding or ratelimiting the traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action.policer_action": {
"type": "object",
"description": "Reference to policer object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action.protocol_policer_action": {
"type": "object",
"description": "Reference to policer object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action.simple_action": {
"type": "string",
"description": "FastAclRuleSimpleAction specifies simple action like PASS or DENY\n\nDrop the traffic\nForward the traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.ip_prefix_set": {
"type": "object",
"description": "A list of references to ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_set.ref": {
"type": "array",
"description": "A list of references to ip_prefix_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port": {
"type": "array",
"description": "L4 port numbers to match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.prefix": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.source": [
"ip_prefix_set",
"prefix"
],
"spec.action.action": [
"policer_action",
"protocol_policer_action",
"simple_action"
]
}
},
{
"name": "list_fast_acl_rules",
"description": "List Fast ACL Rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fast_acl_rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_fast_acl_rule",
"description": "DELETE Fast ACL Rule.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/fast_acl_rules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a fast_acl_rule",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.fast_acl_rule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for fast_acl_ruleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for fast_acl_ruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_fast_acl_rule",
"description": "GET Fast ACL Rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fast_acl_rules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"fast-acls": {
"name": "fast-acls",
"displayName": "Fast Acls",
"operations": [
{
"name": "create_fast_acl",
"description": "Create Fast ACL.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/fast_acls",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of fast_acl",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.fast_acl.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/schemafast_aclCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Fast ACL for IP-based access control at network edge",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "site_choice",
"fields": [
"spec.re_acl",
"spec.site_acl"
],
"reason": "REQUIRED: Choose RE ACL (applies to Regional Edge) or Site ACL (applies to specific site)"
}
],
"example_yaml": "apiVersion: v1\nkind: fast_acl\nmetadata:\n  name: example-fast-acl\n  namespace: system\nspec:\n  re_acl: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-fast-acl\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"re_acl\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-fast-acl",
"namespace": "system"
},
"spec": {
"re_acl": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Fast ACL for IP-based access control at network edge"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service\nIt has destination{destination IP, destination port) and references to `fast_acl_rule`",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_policer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_policer.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl": {
"type": "object",
"description": "Fast ACL definition for RE.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.all_public_vips": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.default_tenant_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.fast_acl_rules": {
"type": "array",
"description": "Fast ACL rules to match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.selected_tenant_vip": {
"type": "object",
"description": "Select various tenant public VIP(s)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl": {
"type": "object",
"description": "Fast ACL definition for Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.fast_acl_rules": {
"type": "array",
"description": "Fast ACL rules to match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.interface_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.outside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.vip_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.site_choice": [
"re_acl",
"site_acl"
],
"spec.re_acl.vip_choice": [
"all_public_vips",
"default_tenant_vip",
"selected_tenant_vip"
],
"spec.site_acl.network_choice": [
"inside_network",
"outside_network"
],
"spec.site_acl.vip_choice": [
"all_services",
"interface_services",
"vip_services"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_fast_acl",
"description": "Replace Fast ACL.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/fast_acls/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a fast_acl",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.fast_acl.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemafast_aclReplaceSpecType"
}
],
"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": "Fast ACL for IP-based access control at network edge",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "site_choice",
"fields": [
"spec.re_acl",
"spec.site_acl"
],
"reason": "REQUIRED: Choose RE ACL (applies to Regional Edge) or Site ACL (applies to specific site)"
}
],
"example_yaml": "apiVersion: v1\nkind: fast_acl\nmetadata:\n  name: example-fast-acl\n  namespace: system\nspec:\n  re_acl: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-fast-acl\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"re_acl\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-fast-acl",
"namespace": "system"
},
"spec": {
"re_acl": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Fast ACL for IP-based access control at network edge"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service\nIt has destination{destination IP, destination port) and references to `fast_acl_rule`",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_policer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_policer.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol_policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl": {
"type": "object",
"description": "Fast ACL definition for RE.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.all_public_vips": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.default_tenant_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.fast_acl_rules": {
"type": "array",
"description": "Fast ACL rules to match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_acl.selected_tenant_vip": {
"type": "object",
"description": "Select various tenant public VIP(s)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl": {
"type": "object",
"description": "Fast ACL definition for Site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.fast_acl_rules": {
"type": "array",
"description": "Fast ACL rules to match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.interface_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.outside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_acl.vip_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.site_choice": [
"re_acl",
"site_acl"
],
"spec.re_acl.vip_choice": [
"all_public_vips",
"default_tenant_vip",
"selected_tenant_vip"
],
"spec.site_acl.network_choice": [
"inside_network",
"outside_network"
],
"spec.site_acl.vip_choice": [
"all_services",
"interface_services",
"vip_services"
]
}
},
{
"name": "list_fast_acls",
"description": "List Fast ACL.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fast_acls",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_fast_acl",
"description": "DELETE Fast ACL.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/fast_acls/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a fast_acl",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.fast_acl.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for fast_aclDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for fast_aclDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_fast_acl",
"description": "GET Fast ACL.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fast_acls/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"fast-acls-for-internet-vips": {
"name": "fast-acls-for-internet-vips",
"displayName": "Fast Acls For Internet Vips",
"operations": [
{
"name": "list_fast_acls_for_internet_vips",
"description": "GET FastACLs For Internet VIPs.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fast_acls_for_internet_vips",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"fast_acls": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "fast_acls",
"type": "array",
"description": "The list of refs of FastACLs."
}
]
},
{
"name": "create_fast_acls_for_internet_vip",
"description": "Set FastACLs For Internet VIPs.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/fast_acls_for_internet_vips",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that\nshould be applied to the Internet VIPs.",
"title": "SetFastACLsForInternetVIPsRequest",
"x-displayname": "Request for SetFastACLsForInternetVIP.",
"x-ves-proto-message": "ves.io.schema.namespace.SetFastACLsForInternetVIPsRequest",
"properties": {
"fast_acls": {
"type": "array",
"description": "The list of refs of FastACLs.",
"title": "fast_acls",
"maxItems": 128,
"items": {
"$ref": "#/components/schemas/schemaviewsObjectRefType"
},
"x-displayname": "FastACLs",
"x-ves-example": "List of refs.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "128"
},
"x-f5xc-example": "list of refs",
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "128"
},
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that should be applied to the Internet VIPs.",
"x-f5xc-description-medium": "SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that should be applied to the Internet VIPs.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceSetFastACLsForInternetVIPsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceSetFastACLsForInternetVIPsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceSetFastACLsForInternetVIPsRequest"
},
"fieldMetadata": {
"fast_acls": {
"type": "array",
"description": "The list of refs of FastACLs.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The name of the namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"filter-sets": {
"name": "filter-sets",
"displayName": "Filter Sets",
"operations": [
{
"name": "create_filter_set",
"description": "Create Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/filter_sets",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of filter_set",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.filter_set.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/filter_setCreateSpecType"
}
],
"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 filter_setCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for filter_setCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for filter_setCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.context_key": {
      "type": "string",
"description": "Indexable context key that identifies a page or page type for which the FilterSet is applicable.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.filter_fields": {
"type": "array",
"description": "List of fields and their values selected by the user.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_filter_set",
"description": "Replace Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/filter_sets/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a filter_set",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.filter_set.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/filter_setReplaceSpecType"
}
],
"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 filter_setReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for filter_setReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for filter_setReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.context_key": {
      "type": "string",
"description": "Indexable context key that identifies a page or page type for which the FilterSet is applicable.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.filter_fields": {
"type": "array",
"description": "List of fields and their values selected by the user.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_filter_sets",
"description": "List Filter Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/filter_sets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_filter_set",
"description": "DELETE Filter Set.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/filter_sets/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a filter_set",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.filter_set.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for filter_setDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for filter_setDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_filter_set",
"description": "GET Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/filter_sets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"find": {
"name": "find",
"displayName": "Find",
"operations": [
{
"name": "create_find",
"description": "Find Filter Sets for 1 or More Context Keys.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/filter_sets/find",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Find Filter Sets API returns FilterSets that match the given context key(s)",
      "title": "Find Filter Sets Request",
"x-displayname": "Find Filter Sets Request.",
"x-ves-proto-message": "ves.io.schema.filter_set.FindFilterSetsReq",
"properties": {
"context_keys": {
      "type": "array",
"description": "Context key(s) that identify one or more console pages/views where filters of the same field/values can be applied.",
      "title": "context_keys",
      "minItems": 1,
"items": {
"type": "string"
},
"x-displayname": "Context Keys.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"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.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Context key(s) that identify one or more console pages/views where filters of the same field/values can be applied.",
      "x-f5xc-description-medium": "Context key(s) that identify one or more console pages/views where filters of the same field/values can be applied.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Find filter sets in the given namespace.",
"title": "namespace",
"x-displayname": "Namespace For Filter Sets.",
"x-ves-example": "Bot-defense-apac.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "bot-defense-apac",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Find filter sets in the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Find Filter Sets API returns FilterSets that match the given context key(s).",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for filter_setFindFilterSetsReq",
"required_fields": [
"context_keys",
      "namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for filter_setFindFilterSetsReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  context_keys: value\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"context_keys\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {
"filter_sets": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"context_keys": "value",
      "namespace": "value"
}
},
"requiredFields": [
"context_keys",
      "namespace"
],
"description": "Minimum configuration for filter_setFindFilterSetsReq"
},
"fieldMetadata": {
"context_keys": {
      "type": "array",
"description": "Context key(s) that identify one or more console pages/views where filters of the same field/values can be applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Find filter sets in the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "filter_sets",
"type": "array",
"description": "List of filter sets with the given context key(s)"
      }
]
}
]
},
	"firewall-logs": {
"name": "firewall-logs",
"displayName": "Firewall Logs",
"operations": [
{
"name": "create_firewall_log",
"description": "Firewall Logs Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/firewall_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch Firewall logs.",
"title": "FirewallLogRequest",
"x-displayname": "Firewall Log Request.",
"x-ves-proto-message": "ves.io.schema.log.FirewallLogRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch Firewall logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch Firewall logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch Firewall logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "0",
"x-f5xc-example": "0",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch Firewall logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch Firewall logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of following fields in Firewall log may be specified in the query.\nSite - Name of the site\nsrc_ip - Source IP Address\ndst_ip - Destination IP Address\npolicy_hits.policy - Policy Name\npolicy_hits.policy_rule - Policy Rule Name\npolicy_hits.result - allow|deny|default_deny\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then Firewall logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the Firewall logs matching the given tenant, namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "{site=\\\"site-1\\\"}",
"x-f5xc-example": "\"{site=\\\"site-1\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of following fields in Firewall log may be specified in the query. Site - Name of the site src_ip - Source IP Address dst_ip ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch Firewall logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch Firewall logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch Firewall logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logFirewallLogRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logFirewallLogRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logFirewallLogRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch Firewall logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch Firewall logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of following fields in Firewall log may be specified in the query.\nSite - Name of the site\nsrc_ip - Source IP Address\ndst_ip - Destination IP Address\npolicy_hits.policy - Policy Name\npolicy_hits.policy_rule - Policy Rule Name\npolicy_hits.result - allow|deny|default_deny\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then Firewall logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the Firewall logs matching the given tenant, namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch Firewall logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"fleets": {
"name": "fleets",
"displayName": "Fleets",
"operations": [
{
"name": "create_fleet",
"description": "Create Fleet.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/fleets",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of fleet",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.fleet.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/schemafleetCreateSpecType"
}
],
"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 fleetCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for fleetCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for fleetCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create fleet will create a fleet object in 'system' namespace of the user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "array",
"description": "Disable node local services on this site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 6,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list": {
"type": "object",
"description": "List of bond devices for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list.bond_devices": {
"type": "array",
"description": "List of bond devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sriov_interface": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_storage_class": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.device_list": {
"type": "object",
"description": "Add device for all interfaces belonging to this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.device_list.devices": {
"type": "array",
"description": "Configuration for all devices in the fleet.\nExamples of devices are - network interfaces, cameras, scanners etc.\nConfiguration a device is applied on VER node if the VER node is member of this fleet and\nhas an corresponding interface/device. The mapping from device configured in fleet with\ninterface/device in VER node depends on the type of device and is documented in\ndevice instance specific sections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_vm": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_default_fleet_config_download": {
"type": "boolean",
"description": "Enable default fleet config, It must be set for storage config and GPU config.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu": {
"type": "object",
"description": "Licensing configuration for NVIDIA vGPU.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.feature_type": {
"type": "string",
"description": "Set feature to be enabled\n\nOperate with a degraded vGPU performance\nEnable NVIDIA vGPU\nEnable NVIDIA RTX Virtual Workstation\nEnable NVIDIA Virtual Compute Server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNLICENSED"
},
"spec.enable_vgpu.server_address": {
"type": "string",
"description": "Set License Server Address.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.server_port": {
"type": "integer",
"description": "Set License Server port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_vm": {
"type": "object",
"description": "VMs support configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.fleet_label": {
"type": "string",
"description": "Fleet_label value is used to create known_label \"F5 XC/fleet=<fleet_label>\"\nThe known_label is created in the \"shared\" namespace for the tenant.\n\nA virtual_site object with name <fleet_label> is also created in \"shared\" namespace for tenant.\nThe virtual_site object will select all sites configured with the known_label above\nfleet_label with \"sfo\" will create a known_label \"F5 XC/fleet=sfo\" in tenant for the fleet.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.inside_virtual_network": {
"type": "array",
"description": "Default inside (site local) virtual network for the fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interface_list": {
"type": "object",
"description": "Add all interfaces belonging to this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interface_list.interfaces": {
"type": "array",
"description": "Add all interfaces belonging to this fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connectors": {
"type": "array",
"description": "Network Connector defines connection between two virtual networks in a given site.\nFleet defines one or more such network connectors.\nThe network connectors configuration is applied on all sites that are member of the fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_firewall": {
"type": "array",
"description": "Network Firewall defines firewall to be applied for the virtual networks in the fleet.\nThe network firewall configuration is applied on all sites that are member of the fleet.\n\nConstraints\nThe Network Firewall is applied on Virtual Networks of type site local network and site local inside network.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_bond_devices": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_storage_device": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_storage_interfaces": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_storage_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.operating_system_version": {
"type": "string",
"description": "Desired Operating System version that is applied to all sites that are member of the fleet.\nCurrent Operating System version can be overridden via site config.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outside_virtual_network": {
"type": "array",
"description": "Default outside (site local) virtual network for the fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces": {
"type": "object",
"description": "List of all custom SR-IOV interfaces configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces.sriov_interface": {
"type": "array",
"description": "Use custom SR-IOV interfaces Configuration.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_class_list.storage_classes": {
"type": "array",
"description": "List of custom storage classes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_device_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_device_list.storage_devices": {
"type": "array",
"description": "List of custom storage devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_interface_list": {
"type": "object",
"description": "Add all interfaces belonging to this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_interface_list.interfaces": {
"type": "array",
"description": "Add all interfaces belonging to this fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.storage_static_routes": {
"type": "object",
"description": "List of storage static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_static_routes.storage_routes": {
"type": "array",
"description": "List of storage static routes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.usb_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.volterra_software_version": {
"type": "string",
"description": "F5XC software version is human readable string matching released set of version components.\nThe given software version is applied to all sites that are member of the fleet.\nCurrent software installed can be overridden via site config.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.bond_choice": [
"bond_device_list",
"no_bond_devices"
],
"spec.dc_cluster_group_choice": [
"dc_cluster_group",
"dc_cluster_group_inside",
"no_dc_cluster_group"
],
"spec.gpu_choice": [
"disable_gpu",
"enable_gpu",
"enable_vgpu"
],
"spec.interface_choice": [
"default_config",
"device_list",
"interface_list"
],
"spec.log_anonymization_mode": [
"disable_log_anonymization",
"enable_log_anonymization"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.sriov_interface_choice": [
"default_sriov_interface",
"sriov_interfaces"
],
"spec.storage_class_choice": [
"default_storage_class",
"storage_class_list"
],
"spec.storage_device_choice": [
"no_storage_device",
"storage_device_list"
],
"spec.storage_interface_choice": [
"no_storage_interfaces",
"storage_interface_list"
],
"spec.storage_static_routes_choice": [
"no_storage_static_routes",
"storage_static_routes"
],
"spec.usb_policy_choice": [
"allow_all_usb",
"deny_all_usb",
"usb_policy"
],
"spec.vm_choice": [
"disable_vm",
"enable_vm"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_fleet",
"description": "Replace Fleet.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/fleets/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a fleet",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.fleet.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/schemafleetReplaceSpecType"
}
],
"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 fleetReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for fleetReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for fleetReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace fleet will replace the contents of given fleet object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "array",
"description": "Disable node local services on this site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 6,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list": {
"type": "object",
"description": "List of bond devices for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list.bond_devices": {
"type": "array",
"description": "List of bond devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_inside.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sriov_interface": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_storage_class": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.device_list": {
"type": "object",
"description": "Add device for all interfaces belonging to this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.device_list.devices": {
"type": "array",
"description": "Configuration for all devices in the fleet.\nExamples of devices are - network interfaces, cameras, scanners etc.\nConfiguration a device is applied on VER node if the VER node is member of this fleet and\nhas an corresponding interface/device. The mapping from device configured in fleet with\ninterface/device in VER node depends on the type of device and is documented in\ndevice instance specific sections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_vm": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_default_fleet_config_download": {
"type": "boolean",
"description": "Enable default fleet config, It must be set for storage config and GPU config.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu": {
"type": "object",
"description": "Licensing configuration for NVIDIA vGPU.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.feature_type": {
"type": "string",
"description": "Set feature to be enabled\n\nOperate with a degraded vGPU performance\nEnable NVIDIA vGPU\nEnable NVIDIA RTX Virtual Workstation\nEnable NVIDIA Virtual Compute Server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNLICENSED"
},
"spec.enable_vgpu.server_address": {
"type": "string",
"description": "Set License Server Address.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.server_port": {
"type": "integer",
"description": "Set License Server port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_vm": {
"type": "object",
"description": "VMs support configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.inside_virtual_network": {
"type": "array",
"description": "Default inside (site local) virtual network for the fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interface_list": {
"type": "object",
"description": "Add all interfaces belonging to this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interface_list.interfaces": {
"type": "array",
"description": "Add all interfaces belonging to this fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connectors": {
"type": "array",
"description": "Network Connector defines connection between two virtual networks in a given site.\nFleet defines one or more such network connectors.\nThe network connectors configuration is applied on all sites that are member of the fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_firewall": {
"type": "array",
"description": "Network Firewall defines firewall to be applied for the virtual networks in the fleet.\nThe network firewall configuration is applied on all sites that are member of the fleet.\n\nConstraints\nThe Network Firewall is applied on Virtual Networks of type site local network and site local inside network.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_bond_devices": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_storage_device": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_storage_interfaces": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_storage_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.operating_system_version": {
"type": "string",
"description": "Desired Operating System version that is applied to all sites that are member of the fleet.\nCurrent Operating System version can be overridden via site config.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outside_virtual_network": {
"type": "array",
"description": "Default outside (site local) virtual network for the fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces": {
"type": "object",
"description": "List of all custom SR-IOV interfaces configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces.sriov_interface": {
"type": "array",
"description": "Use custom SR-IOV interfaces Configuration.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_class_list.storage_classes": {
"type": "array",
"description": "List of custom storage classes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_device_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_device_list.storage_devices": {
"type": "array",
"description": "List of custom storage devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_interface_list": {
"type": "object",
"description": "Add all interfaces belonging to this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_interface_list.interfaces": {
"type": "array",
"description": "Add all interfaces belonging to this fleet.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.storage_static_routes": {
"type": "object",
"description": "List of storage static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.storage_static_routes.storage_routes": {
"type": "array",
"description": "List of storage static routes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.usb_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.volterra_software_version": {
"type": "string",
"description": "F5XC software version is human readable string matching released set of version components.\nThe given software version is applied to all sites that are member of the fleet.\nCurrent software installed can be overridden via site config.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.bond_choice": [
"bond_device_list",
"no_bond_devices"
],
"spec.dc_cluster_group_choice": [
"dc_cluster_group",
"dc_cluster_group_inside",
"no_dc_cluster_group"
],
"spec.gpu_choice": [
"disable_gpu",
"enable_gpu",
"enable_vgpu"
],
"spec.interface_choice": [
"default_config",
"device_list",
"interface_list"
],
"spec.log_anonymization_mode": [
"disable_log_anonymization",
"enable_log_anonymization"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.sriov_interface_choice": [
"default_sriov_interface",
"sriov_interfaces"
],
"spec.storage_class_choice": [
"default_storage_class",
"storage_class_list"
],
"spec.storage_device_choice": [
"no_storage_device",
"storage_device_list"
],
"spec.storage_interface_choice": [
"no_storage_interfaces",
"storage_interface_list"
],
"spec.storage_static_routes_choice": [
"no_storage_static_routes",
"storage_static_routes"
],
"spec.usb_policy_choice": [
"allow_all_usb",
"deny_all_usb",
"usb_policy"
],
"spec.vm_choice": [
"disable_vm",
"enable_vm"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
]
}
},
{
"name": "list_fleets",
"description": "List Fleet.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fleets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_fleet",
"description": "DELETE Fleet.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/fleets/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a fleet",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.fleet.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for fleetDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for fleetDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
}
},
{
"name": "get_fleet",
"description": "GET Fleet",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/fleets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"flow-anomalys": {
"name": "flow-anomalys",
"displayName": "Flow Anomalys",
"operations": [
{
"name": "list_flow_anomalys",
"description": "List Flow Anomaly.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/flow_anomalys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_flow_anomaly",
"description": "GET Flow Anomaly.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/flow_anomalys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"flow-collection-addon-subscribe": {
"name": "flow-collection-addon-subscribe",
"displayName": "Flow Collection Addon Subscribe",
"operations": [
{
"name": "create_flow_collection_addon_subscribe",
"description": "Subscribe to Flow Collection.",
"method": "POST",
"path": "/api/config/namespaces/system/flow-collection/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Flow Collection.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.flow.SubscribeRequest",
"properties": {
"service_type": {
"allOf": [
{
"$ref": "#/components/schemas/schemaflowServiceType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to subscribe to Flow Collection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for flowSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for flowSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"flow_anomaly_detection_last_enabled_time": {
"type": "string"
},
"last_enabled_time": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for flowSubscribeRequest"
},
"fieldMetadata": {
"service_type": {
"type": "string",
"description": "Service type for subscribing/unsubscribing flow-collection/flow-anomaly-detection\n\nby default flow collection is subscribed/unsubscribed\nFlow Anomaly Detection\nSubscribe/unsubscribe to both flow collection and anomaly detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "FLOW_COLLECTION"
}
},
"responseSummary": [
{
"field": "flow_anomaly_detection_last_enabled_time",
"type": "string",
"description": "Last Enabled Time for flow anomaly detection subscription request."
},
{
"field": "last_enabled_time",
"type": "string",
"description": "Last Enabled Time for flow collection subscription request."
}
]
}
]
},
	"flow-collection-addon-subscription-status": {
"name": "flow-collection-addon-subscription-status",
"displayName": "Flow Collection Addon Subscription Status",
"operations": [
{
"name": "list_flow_collection_addon_subscription_status",
"description": "Check subscription status for Flow Collection.",
"method": "GET",
"path": "/api/config/namespaces/system/flow-collection/addon/subscription-status",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"flow_anomaly_detection_last_enabled_time": {
"type": "string"
},
"last_enabled_time": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "flow_anomaly_detection_last_enabled_time",
"type": "string",
"description": "Last Enabled Time for flow anomaly detection subscription request."
},
{
"field": "flow_anomaly_detection_result",
"type": "object",
"description": ""
},
{
"field": "last_enabled_time",
"type": "string",
"description": "Last Enabled Time for flow collection subscription request."
},
{
"field": "result",
"type": "object",
"description": ""
}
]
}
]
},
	"flow-collection-addon-unsubscribe": {
"name": "flow-collection-addon-unsubscribe",
"displayName": "Flow Collection Addon Unsubscribe",
"operations": [
{
"name": "create_flow_collection_addon_unsubscribe",
"description": "Unsubscribe to Flow Collection.",
"method": "POST",
"path": "/api/config/namespaces/system/flow-collection/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Flow Collection.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.flow.UnsubscribeRequest",
"properties": {
"service_type": {
"allOf": [
{
"$ref": "#/components/schemas/schemaflowServiceType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to unsubscribe to Flow Collection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for flowUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for flowUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for flowUnsubscribeRequest"
},
"fieldMetadata": {
"service_type": {
"type": "string",
"description": "Service type for subscribing/unsubscribing flow-collection/flow-anomaly-detection\n\nby default flow collection is subscribed/unsubscribed\nFlow Anomaly Detection\nSubscribe/unsubscribe to both flow collection and anomaly detection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "FLOW_COLLECTION"
}
}
}
]
},
	"flows-flow-collection": {
"name": "flows-flow-collection",
"displayName": "Flows Flow Collection",
"operations": [
{
"name": "create_flows_flow_collection",
"description": "Flow Collection.",
"method": "POST",
"path": "/api/data/namespaces/system/flows/flow_collection",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Top Talkers Request",
"x-displayname": "Top Talkers Request.",
"x-ves-proto-message": "ves.io.schema.flow.TopTalkersRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/flowFieldSelector"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{SITE=\\\"site-1\\\"}",
"x-f5xc-example": "\"{SITE=\\\"site-1\\\"}\"",
"x-f5xc-description-short": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\"...",
"x-f5xc-description-medium": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/schemaflowLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by labels specified in the group_by field.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "5",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "20000"
},
"x-f5xc-example": "5",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "20000"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 20000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "array",
"description": "Sort the data by specified fields, in the given direction.",
"title": "Sort by",
"items": {
"$ref": "#/components/schemas/flowSortBy"
},
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort the data by specified fields, in the given direction.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If...",
"x-f5xc-description-medium": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for flowTopTalkersRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for flowTopTalkersRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for flowTopTalkersRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 20000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "array",
"description": "Sort the data by specified fields, in the given direction.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "FlowData wraps the response for the flow request."
}
]
}
]
},
	"flows-top-flow-anomalies": {
"name": "flows-top-flow-anomalies",
"displayName": "Flows Top Flow Anomalies",
"operations": [
{
"name": "create_flows_top_flow_anomalie",
"description": "Flow Anomaly detection.",
"method": "POST",
"path": "/api/data/namespaces/system/flows/top_flow_anomalies",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Top flow anomalies request",
"x-displayname": "Top flow anomalies request.",
"x-ves-proto-message": "ves.io.schema.flow.TopFlowAnomaliesRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/flowFieldSelector"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"title": "Label Filter",
"maxLength": 1024,
"x-displayname": "Filter",
"x-ves-example": "{SITE=\\\"site-1\\\"}",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "\"{SITE=\\\"site-1\\\"}\"",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\"...",
"x-f5xc-description-medium": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"title": "Group by",
"maxItems": 20,
"items": {
"$ref": "#/components/schemas/schemaflowLabel"
},
"x-displayname": "Group By",
"x-ves-validation-rules": {
"ves.io.schema.rules.enum.defined_only": "true",
"ves.io.schema.rules.repeated.max_items": "20"
},
"x-validation-rules": {
"ves.io.schema.rules.enum.defined_only": "true",
"ves.io.schema.rules.repeated.max_items": "20"
},
"x-f5xc-description-short": "Aggregate data by labels specified in the group_by field.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "5",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "1000"
},
"x-f5xc-example": "5",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "1000"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 1000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "array",
"description": "Sort the data by specified fields, in the given direction.",
"title": "Sort by",
"items": {
"$ref": "#/components/schemas/flowSortBy"
},
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort the data by specified fields, in the given direction.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If...",
"x-f5xc-description-medium": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for flowTopFlowAnomaliesRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for flowTopFlowAnomaliesRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"flowAnomalyData": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for flowTopFlowAnomaliesRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 1000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "array",
"description": "Sort the data by specified fields, in the given direction.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "flowAnomalyData",
"type": "array",
"description": "FlowAnomalyData wraps the response for flows with anomalies."
}
]
}
]
},
	"flows-top-talkers": {
"name": "flows-top-talkers",
"displayName": "Flows Top Talkers",
"operations": [
{
"name": "create_flows_top_talker",
"description": "Top Talkers.",
"method": "POST",
"path": "/api/data/namespaces/system/flows/top_talkers",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Top Talkers Request",
"x-displayname": "Top Talkers Request.",
"x-ves-proto-message": "ves.io.schema.flow.TopTalkersRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/flowFieldSelector"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{SITE=\\\"site-1\\\"}",
"x-f5xc-example": "\"{SITE=\\\"site-1\\\"}\"",
"x-f5xc-description-short": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\"...",
"x-f5xc-description-medium": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/schemaflowLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by labels specified in the group_by field.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "5",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "20000"
},
"x-f5xc-example": "5",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "20000"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 20000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "array",
"description": "Sort the data by specified fields, in the given direction.",
"title": "Sort by",
"items": {
"$ref": "#/components/schemas/flowSortBy"
},
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort the data by specified fields, in the given direction.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If...",
"x-f5xc-description-medium": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for flowTopTalkersRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for flowTopTalkersRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for flowTopTalkersRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 20000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "array",
"description": "Sort the data by specified fields, in the given direction.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "FlowData wraps the response for the flow request."
}
]
}
]
},
	"forward-proxy-policys": {
"name": "forward-proxy-policys",
"displayName": "Forward Proxy Policys",
"operations": [
{
"name": "create_forward_proxy_policy",
"description": "Create Forward Proxy Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/forward_proxy_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of forward_proxy_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.forward_proxy_policy.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/viewsforward_proxy_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Egress proxy policy for controlling outbound traffic from sites",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "proxy_choice",
"fields": [
"spec.any_proxy",
"spec.drp_http_connect",
"spec.network_connector",
"spec.proxy_label_selector"
],
"reason": "Choose proxy scope (any_proxy requires system namespace; drp_http_connect is user namespace only)"
},
{
"name": "rule_choice",
"fields": [
"spec.allow_all",
"spec.allow_list",
"spec.deny_list",
"spec.rule_list"
],
"reason": "Choose rule type"
}
],
"example_yaml": "metadata:\n  name: example-fpp\n  namespace: default\nspec:\n  drp_http_connect: {}\n  allow_all: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-fpp\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"drp_http_connect\": {},\n    \"allow_all\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-fpp",
"namespace": "default"
},
"spec": {
"drp_http_connect": {},
"allow_all": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Egress proxy policy for controlling outbound traffic from sites"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Forward Proxy Policy specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list": {
"type": "object",
"description": "URL(s) and domains policy for forward proxy for a connection type (TLS or HTTP)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.dest_list": {
"type": "array",
"description": "L4 destinations for non-HTTP and non-TLS connections and TLS connections without SNI.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.http_list": {
"type": "array",
"description": "URLs for HTTP connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.tls_list": {
"type": "array",
"description": "Domains in SNI for TLS connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list": {
"type": "object",
"description": "URL(s) and domains policy for forward proxy for a connection type (TLS or HTTP)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.dest_list": {
"type": "array",
"description": "L4 destinations for non-HTTP and non-TLS connections and TLS connections without SNI.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.http_list": {
"type": "array",
"description": "URLs for HTTP connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.tls_list": {
"type": "array",
"description": "Domains in SNI for TLS connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.drp_http_connect": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connector": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connector.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.network_connector.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connector.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_label_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.rule_list": {
"type": "object",
"description": "List of custom rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list.rules": {
"type": "array",
"description": "List of custom rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.proxy_choice": [
"any_proxy",
"drp_http_connect",
"network_connector",
"proxy_label_selector"
],
"spec.rule_choice": [
"allow_all",
"allow_list",
"deny_list",
"rule_list"
],
"spec.allow_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
],
"spec.deny_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_forward_proxy_policy",
"description": "Replace Forward Proxy Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/forward_proxy_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a forward_proxy_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.forward_proxy_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsforward_proxy_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Egress proxy policy for controlling outbound traffic from sites",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "proxy_choice",
"fields": [
"spec.any_proxy",
"spec.drp_http_connect",
"spec.network_connector",
"spec.proxy_label_selector"
],
"reason": "Choose proxy scope (any_proxy requires system namespace; drp_http_connect is user namespace only)"
},
{
"name": "rule_choice",
"fields": [
"spec.allow_all",
"spec.allow_list",
"spec.deny_list",
"spec.rule_list"
],
"reason": "Choose rule type"
}
],
"example_yaml": "metadata:\n  name: example-fpp\n  namespace: default\nspec:\n  drp_http_connect: {}\n  allow_all: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-fpp\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"drp_http_connect\": {},\n    \"allow_all\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-fpp",
"namespace": "default"
},
"spec": {
"drp_http_connect": {},
"allow_all": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Egress proxy policy for controlling outbound traffic from sites"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Forward Proxy Policy replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list": {
"type": "object",
"description": "URL(s) and domains policy for forward proxy for a connection type (TLS or HTTP)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.dest_list": {
"type": "array",
"description": "L4 destinations for non-HTTP and non-TLS connections and TLS connections without SNI.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.http_list": {
"type": "array",
"description": "URLs for HTTP connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.tls_list": {
"type": "array",
"description": "Domains in SNI for TLS connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list": {
"type": "object",
"description": "URL(s) and domains policy for forward proxy for a connection type (TLS or HTTP)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.dest_list": {
"type": "array",
"description": "L4 destinations for non-HTTP and non-TLS connections and TLS connections without SNI.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.http_list": {
"type": "array",
"description": "URLs for HTTP connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.tls_list": {
"type": "array",
"description": "Domains in SNI for TLS connections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.drp_http_connect": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connector": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connector.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.network_connector.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_connector.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy_label_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.rule_list": {
"type": "object",
"description": "List of custom rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list.rules": {
"type": "array",
"description": "List of custom rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.proxy_choice": [
"any_proxy",
"drp_http_connect",
"network_connector",
"proxy_label_selector"
],
"spec.rule_choice": [
"allow_all",
"allow_list",
"deny_list",
"rule_list"
],
"spec.allow_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
],
"spec.deny_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
]
}
},
{
"name": "list_forward_proxy_policys",
"description": "List Configure Forward Proxy Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/forward_proxy_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_forward_proxy_policy",
"description": "DELETE Configure Forward Proxy Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/forward_proxy_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a forward_proxy_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.forward_proxy_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for forward_proxy_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for forward_proxy_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_forward_proxy_policy",
"description": "GET Forward Proxy Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/forward_proxy_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"forwarding-classs": {
"name": "forwarding-classs",
"displayName": "Forwarding Classs",
"operations": [
{
"name": "create_forwarding_cla",
"description": "Create Forwarding Class.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/forwarding_classs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of forwarding_class",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.forwarding_class.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/forwarding_classCreateSpecType"
}
],
"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 forwarding_classCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for forwarding_classCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for forwarding_classCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Forwarding Class is created by users in system namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dscp": {
"type": "object",
"description": "DSCP marking setting as per RFC 2475.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dscp.drop_precedence": {
"type": "string",
"description": "DSCP Assured forwarding drop precedence\n\nDSCP Low drop precedence\nDSCP Low drop precedence\nDSCP Low drop precedence\nDSCP drop precedence value is taken from output of policer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dscp.dscp_class": {
"type": "string",
"description": "DSCP Precedence Level Values\n\nBest Effort service will GET any available bandwidth\nDSCP Class 1 service\nDSCP Class 2 service\nDSCP Class 3 service\nDSCP Class 4 service\nExpress Forwarding is used for low latency traffic\nControl is used for routing traffic, not recommended\nLink Layer traffic like LACP or keepalive, not recommended.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DSCP_BEST_EFFORT"
},
"spec.dscp_based_queue": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interface_group": {
"type": "string",
"description": "Interface group, group membership by adding group label to interface\n\nChoose any of the available interfaces\nChoose all interfaces with label group1\nChoose all interfaces with label group2\nChoose all interfaces with label group3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY_AVAILABLE_INTERFACE"
},
"spec.no_marking": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_policer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policer.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.queue_id_to_use": {
"type": "string",
"description": "DSCP Precedence Level Values\n\nBest Effort service will GET any available bandwidth\nDSCP Class 1 service\nDSCP Class 2 service\nDSCP Class 3 service\nDSCP Class 4 service\nExpress Forwarding is used for low latency traffic\nControl is used for routing traffic, not recommended\nLink Layer traffic like LACP or keepalive, not recommended.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DSCP_BEST_EFFORT"
},
"spec.tos_value": {
"type": "integer",
"description": "Exclusive with [dscp no_marking]\nDecimal value of raw 8 bit TOS. In above example DSCP 10 = Precedence Class 1 and drop precedence low.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 255,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.marking_choice": [
"dscp",
"no_marking",
"tos_value"
],
"spec.policer_choice": [
"no_policer",
"policer"
],
"spec.queueing_choice": [
"dscp_based_queue",
"queue_id_to_use"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_forwarding_cla",
"description": "Replace Forwarding Class.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/forwarding_classs/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a forwarding_class",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.forwarding_class.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/forwarding_classReplaceSpecType"
}
],
"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 forwarding_classReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for forwarding_classReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for forwarding_classReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Forwarding Class will replace the contains of given object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dscp": {
"type": "object",
"description": "DSCP marking setting as per RFC 2475.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dscp.drop_precedence": {
"type": "string",
"description": "DSCP Assured forwarding drop precedence\n\nDSCP Low drop precedence\nDSCP Low drop precedence\nDSCP Low drop precedence\nDSCP drop precedence value is taken from output of policer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dscp.dscp_class": {
"type": "string",
"description": "DSCP Precedence Level Values\n\nBest Effort service will GET any available bandwidth\nDSCP Class 1 service\nDSCP Class 2 service\nDSCP Class 3 service\nDSCP Class 4 service\nExpress Forwarding is used for low latency traffic\nControl is used for routing traffic, not recommended\nLink Layer traffic like LACP or keepalive, not recommended.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DSCP_BEST_EFFORT"
},
"spec.dscp_based_queue": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interface_group": {
"type": "string",
"description": "Interface group, group membership by adding group label to interface\n\nChoose any of the available interfaces\nChoose all interfaces with label group1\nChoose all interfaces with label group2\nChoose all interfaces with label group3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY_AVAILABLE_INTERFACE"
},
"spec.no_marking": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_policer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policer": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policer.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policer.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.queue_id_to_use": {
"type": "string",
"description": "DSCP Precedence Level Values\n\nBest Effort service will GET any available bandwidth\nDSCP Class 1 service\nDSCP Class 2 service\nDSCP Class 3 service\nDSCP Class 4 service\nExpress Forwarding is used for low latency traffic\nControl is used for routing traffic, not recommended\nLink Layer traffic like LACP or keepalive, not recommended.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DSCP_BEST_EFFORT"
},
"spec.tos_value": {
"type": "integer",
"description": "Exclusive with [dscp no_marking]\nDecimal value of raw 8 bit TOS. In above example DSCP 10 = Precedence Class 1 and drop precedence low.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 255,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.marking_choice": [
"dscp",
"no_marking",
"tos_value"
],
"spec.policer_choice": [
"no_policer",
"policer"
],
"spec.queueing_choice": [
"dscp_based_queue",
"queue_id_to_use"
]
}
},
{
"name": "list_forwarding_classs",
"description": "List Forwarding Class.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/forwarding_classs",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_forwarding_cla",
"description": "DELETE Forwarding Class.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/forwarding_classs/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a forwarding_class",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.forwarding_class.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for forwarding_classDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for forwarding_classDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_forwarding_cla",
"description": "GET Forwarding Class.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/forwarding_classs/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"gcp-vpc-sites": {
"name": "gcp-vpc-sites",
"displayName": "Gcp Vpc Sites",
"operations": [
{
"name": "create_gcp_vpc_site",
"description": "Create GCP VPC site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/gcp_vpc_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of gcp_vpc_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.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/viewsgcp_vpc_siteCreateSpecType"
}
],
"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 gcp_vpc_siteCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for gcp_vpc_siteCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for gcp_vpc_siteCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the GCP VPC site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.cloud_credentials": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_credentials.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_credentials.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_credentials.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_encryption": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disk_size": {
"type": "integer",
"description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 64000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_encryption": {
"type": "object",
"description": "Information related to disk encryption.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_encryption.kms_key_resource_id": {
      "type": "string",
"description": "GCP KMS Key to be used to encrypt the disk attached to the VM.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_encryption.kms_key_ring_id": {
      "type": "string",
"description": "Key ring in which the CMK to be used to encrypt is present.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_labels": {
"type": "object",
"description": "GCP Label is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in GCP console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_region": {
"type": "string",
"description": "Name for GCP Region.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw": {
"type": "object",
"description": "Two interface GCP ingress/egress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.gcp_certified_hw": {
"type": "string",
"description": "Name for GCP certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.gcp_zone_names": {
"type": "array",
"description": "X-required\nList of zones when instances will be created, needs to match with region selected.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.node_number": {
"type": "integer",
"description": "Number of main nodes to create, either 1 or 3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw": {
"type": "object",
"description": "Single interface GCP ingress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.gcp_certified_hw": {
"type": "string",
"description": "Name for GCP certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.gcp_zone_names": {
"type": "array",
"description": "X-required\nList of zones when instances will be created, needs to match with region selected.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.local_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.local_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.node_number": {
"type": "integer",
"description": "Number of main nodes to create, either 1 or 3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.instance_type": {
"type": "string",
"description": "Select Instance size based on performance needed.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connect_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity": {
"type": "object",
"description": "Private Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.cloud_link": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster": {
"type": "object",
"description": "App Stack cluster of single interface GCP site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.default_storage": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.gcp_certified_hw": {
"type": "string",
"description": "Name for GCP certified hardware.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.gcp_zone_names": {
"type": "array",
"description": "X-required\nList of zones when instances will be created, needs to match with region selected.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.node_number": {
"type": "integer",
"description": "Number of main nodes to create, either 1 or 3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.site_local_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.site_local_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.deployment": [
"cloud_credentials"
      ],
"spec.encryption_choice": [
"disable_encryption",
"enable_encryption"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.private_connectivity_choice": [
"private_connect_disabled",
"private_connectivity"
],
"spec.site_type": [
"ingress_egress_gw",
"ingress_gw",
"voltstack_cluster"
],
"spec.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.ingress_egress_gw.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw.inside_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.ingress_egress_gw.inside_subnet.choice": [
"existing_subnet",
"new_subnet"
],
"spec.ingress_egress_gw.outside_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.ingress_egress_gw.outside_subnet.choice": [
"existing_subnet",
"new_subnet"
],
"spec.ingress_egress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_gw.local_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.ingress_gw.local_subnet.choice": [
"existing_subnet",
"new_subnet"
],
"spec.ingress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.private_connectivity.network_options": [
"inside",
"outside"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
],
"spec.voltstack_cluster.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster.storage_class_choice": [
"default_storage",
"storage_class_list"
],
"spec.voltstack_cluster.site_local_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.voltstack_cluster.site_local_subnet.choice": [
"existing_subnet",
"new_subnet"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_gcp_vpc_site",
"description": "Replace GCP VPC site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/gcp_vpc_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a gcp_vpc_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.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/viewsgcp_vpc_siteReplaceSpecType"
}
],
"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 gcp_vpc_siteReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for gcp_vpc_siteReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for gcp_vpc_siteReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the GCP VPC site replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.cloud_credentials": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_credentials.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cloud_credentials.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cloud_credentials.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disk_size": {
"type": "integer",
"description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 64000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_region": {
"type": "string",
"description": "Name for GCP Region.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw": {
"type": "object",
"description": "Two interface GCP ingress/egress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_inside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.dc_cluster_group_outside_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.gcp_zone_names": {
"type": "array",
"description": "X-required\nList of zones when instances will be created, needs to match with region selected.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.inside_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_inside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.node_number": {
"type": "integer",
"description": "Number of main nodes to create, either 1 or 3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.outside_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_egress_gw.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw": {
"type": "object",
"description": "Single interface GCP ingress site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.gcp_zone_names": {
"type": "array",
"description": "X-required\nList of zones when instances will be created, needs to match with region selected.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ingress_gw.local_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.local_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.node_number": {
"type": "integer",
"description": "Number of main nodes to create, either 1 or 3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_gw.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.instance_type": {
"type": "string",
"description": "Select Instance size based on performance needed.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connect_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity": {
"type": "object",
"description": "Private Connect Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.cloud_link": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.private_connectivity.outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the site.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster": {
"type": "object",
"description": "App Stack cluster of single interface GCP nodes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.dc_cluster_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.gcp_zone_names": {
"type": "array",
"description": "X-required\nList of zones when instances will be created, needs to match with region selected.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_dc_cluster_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.no_outside_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.node_number": {
"type": "integer",
"description": "Number of main nodes to create, either 1 or 3.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.outside_static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.site_local_network": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.site_local_subnet": {
"type": "object",
"description": "This defines choice about GCP VPC network for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.voltstack_cluster.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services",
"default_blocked_services"
],
"spec.deployment": [
"cloud_credentials"
      ],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.private_connectivity_choice": [
"private_connect_disabled",
"private_connectivity"
],
"spec.site_type": [
"ingress_egress_gw",
"ingress_gw",
"voltstack_cluster"
],
"spec.ingress_egress_gw.dc_cluster_group_choice": [
"dc_cluster_group_inside_vn",
"dc_cluster_group_outside_vn",
"no_dc_cluster_group"
],
"spec.ingress_egress_gw.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.ingress_egress_gw.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.ingress_egress_gw.inside_static_route_choice": [
"inside_static_routes",
"no_inside_static_routes"
],
"spec.ingress_egress_gw.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.ingress_egress_gw.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.ingress_egress_gw.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.ingress_egress_gw.inside_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.ingress_egress_gw.inside_subnet.choice": [
"existing_subnet",
"new_subnet"
],
"spec.ingress_egress_gw.outside_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.ingress_egress_gw.outside_subnet.choice": [
"existing_subnet",
"new_subnet"
],
"spec.ingress_egress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.ingress_gw.local_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.ingress_gw.local_subnet.choice": [
"existing_subnet",
"new_subnet"
],
"spec.ingress_gw.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.private_connectivity.network_options": [
"inside",
"outside"
],
"spec.voltstack_cluster.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.voltstack_cluster.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.voltstack_cluster.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.voltstack_cluster.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.voltstack_cluster.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.voltstack_cluster.outside_static_route_choice": [
"no_outside_static_routes",
"outside_static_routes"
],
"spec.voltstack_cluster.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.voltstack_cluster.site_local_network.choice": [
"existing_network",
"new_network",
"new_network_autogenerate"
],
"spec.voltstack_cluster.site_local_subnet.choice": [
"existing_subnet",
"new_subnet"
]
}
},
{
"name": "list_gcp_vpc_sites",
"description": "List Configure GCP VPC Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/gcp_vpc_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_gcp_vpc_site",
"description": "DELETE Configure GCP VPC Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/gcp_vpc_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a gcp_vpc_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for gcp_vpc_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for gcp_vpc_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
}
},
{
"name": "get_gcp_vpc_site",
"description": "GET GCP VPC site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/gcp_vpc_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"gen-ai": {
"name": "gen-ai",
"displayName": "Gen Ai",
"operations": [
{
"name": "create_gen_ai",
"description": "Eval AI Assistant Query.",
"method": "POST",
"path": "/api/gen-ai/namespaces/{namespace}/eval_query",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "AI Assistant Query Request.",
"title": "AI Assistant Query Request",
"x-displayname": "AI Assistant Query Request.",
"x-ves-proto-message": "ves.io.schema.ai_assistant.AIAssistantQueryRequest",
"properties": {
"current_query": {
"type": "string",
"description": "Current query will be in text format.",
"title": "current_query",
"x-displayname": "Current query.",
"x-ves-example": "Explain security event 00000000-0000-4000-8000-f44fac7dd7bf.",
"x-f5xc-example": "Explain security event 00000000-0000-4000-8000-f44fac7dd7bf",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the HTTP Load Balancer for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace of the HTTP Load Balancer for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ai_assistantAIAssistantQueryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ai_assistantAIAssistantQueryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ai_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ai_assistantAIAssistantQueryRequest"
},
"fieldMetadata": {
"current_query": {
"type": "string",
"description": "Current query will be in text format.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the HTTP Load Balancer for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"generate-token": {
"name": "generate-token",
      "displayName": "Generate Token",
      "operations": [
{
"name": "list_generate_token",
      "description": "Generate Token.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/third_party_applications/{name}/generate_token",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"token": {
      "type": "string"
}
}
},
"responseSummary": [
{
"field": "token",
      "type": "string",
"description": "Authentication or access token"
      }
]
}
]
},
	"geo-configs": {
"name": "geo-configs",
"displayName": "Geo Configs",
"operations": [
{
"name": "get_geo_config",
"description": "GET Geo Config.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/geo_configs/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"get-dns-info": {
"name": "get-dns-info",
"displayName": "Get Dns Info",
"operations": [
{
"name": "list_get_dns_info",
"description": "GET DNS Info.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/get-dns-info",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "dns_info",
"type": "object",
"description": ""
}
]
}
]
},
	"get-security-config": {
"name": "get-security-config",
"displayName": "Get Security Config",
"operations": [
{
"name": "create_get_security_config",
"description": "GET Security Config for BIG-IP Load Balancer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/bigip_virtual_servers/get_security_config",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request of GET Security Config Spec API.",
      "title": "Get Security Config request",
"x-displayname": "GET Security Config Request.",
"x-ves-oneof-field-loadbalancer_choice": "[\"all_bigip_virtual_servers\",\"bigip_virtual_servers_list\"]",
"x-ves-proto-message": "ves.io.schema.views.bigip_virtual_server.GetSecurityConfigReq",
"properties": {
"all_bigip_virtual_servers": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_servers_list": {
"allOf": [
{
"$ref": "#/components/schemas/bigip_virtual_serverBigIPVirtualServerList"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the BIG-IP Load Balancer for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the BIG-IP Load Balancer for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request of GET Security Config Spec API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bigip_virtual_serverGetSecurityConfigReq",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bigip_virtual_serverGetSecurityConfigReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object",
"properties": {
"api_protection": {
      "type": "array"
},
"app_firewall": {
"type": "array"
},
"app_firewall_per_route": {
"type": "array"
},
"bot_defense": {
"type": "array"
},
"ddos_detection": {
"type": "array"
},
"protected": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for bigip_virtual_serverGetSecurityConfigReq"
},
"fieldMetadata": {
"all_bigip_virtual_servers": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_servers_list": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"bigip_virtual_servers_list.bigip_virtual_servers": {
"type": "array",
"description": "IP address configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the BIG-IP Load Balancer for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"loadbalancer_choice": [
"all_bigip_virtual_servers",
"bigip_virtual_servers_list"
]
},
"responseSummary": [
{
"field": "api_protection",
      "type": "array",
"description": "API version or group"
      },
{
"field": "app_firewall",
"type": "array",
"description": "Configuration parameter for app firewall"
},
{
"field": "app_firewall_per_route",
"type": "array",
"description": "Configuration parameter for app firewall per route"
},
{
"field": "bot_defense",
"type": "array",
"description": "Configuration parameter for bot defense"
},
{
"field": "ddos_detection",
"type": "array",
"description": "Configuration parameter for ddos detection"
},
{
"field": "protected",
"type": "array",
"description": "Protection or security configuration"
}
]
}
]
},
	"gia-gia-allocateip": {
"name": "gia-gia-allocateip",
"displayName": "Gia Gia Allocateip",
"operations": [
{
"name": "create_gia_gia_allocateip",
"description": "Allocate IP through Global IP Allocator.",
"method": "POST",
"path": "/api/gia/gia/allocateip",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'AllocateIP' RPC.",
"title": "AllocateIP Request",
"x-displayname": "AllocateIP Request.",
"x-ves-proto-message": "ves.io.schema.gia.AllocateIPRequest",
"properties": {
"context": {
"type": "string",
"description": "This is the global IP allocator context from which IP allocation will happen\nOptional: If not specified, gia will try to allocate IP from default IP range.",
"title": "context",
"x-displayname": "Context",
"x-ves-example": "App-VIP-pool-1.",
"x-f5xc-example": "app-vip-pool-1",
"x-f5xc-description-short": "Global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.",
"x-f5xc-description-medium": "Global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_v6_range": {
"type": "boolean",
"description": "Optional: If not specified, v4 range for this tenant will be used.",
"title": "use_v6_range",
"format": "boolean",
"x-displayname": "Use IPv6 Range.",
"x-f5xc-example": "false",
"x-f5xc-description-short": "Optional: If not specified, v4 range for this tenant will be used.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for giaAllocateIPRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for giaAllocateIPRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"error_message": {
"type": "string"
},
"ip": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for giaAllocateIPRequest"
},
"fieldMetadata": {
"context": {
"type": "string",
"description": "This is the global IP allocator context from which IP allocation will happen\nOptional: If not specified, gia will try to allocate IP from default IP range.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_v6_range": {
"type": "boolean",
"description": "Optional: If not specified, v4 range for this tenant will be used.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "error_message",
"type": "string",
"description": "Error message from global IP allocator."
},
{
"field": "ip",
"type": "string",
"description": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1)"
}
]
}
]
},
	"gia-gia-deallocateip": {
"name": "gia-gia-deallocateip",
"displayName": "Gia Gia Deallocateip",
"operations": [
{
"name": "delete_gia_gia_deallocateip",
"description": "Deallocate IP through Global IP Allocator.",
"method": "DELETE",
"path": "/api/gia/gia/deallocateip",
      "dangerLevel": "high",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DeAllocateIP' RPC.",
"title": "DeAllocateIPRequest is used to deallocate an ip",
"x-displayname": "DeAllocateIP Request.",
"x-ves-proto-message": "ves.io.schema.gia.DeallocateIPRequest",
"properties": {
"context": {
"type": "string",
"description": "This is the global IP allocator context from which IP deallocation will happen\nOptional: If not specified, gia will try to deallocate given IP from default IP range.",
"title": "context",
"x-displayname": "Context",
"x-ves-example": "App-VIP-pool-1.",
"x-f5xc-example": "app-vip-pool-1",
"x-f5xc-description-short": "Global IP allocator context from which IP deallocation will happen Optional: If not specified, gia will try to deallocate given IP from default IP...",
"x-f5xc-description-medium": "Global IP allocator context from which IP deallocation will happen Optional: If not specified, gia will try to deallocate given IP from default IP range.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ip": {
"type": "string",
"description": "IP which needs to de-allocated.",
"title": "ip address",
"x-displayname": "IP Address.",
"x-ves-example": "192.0.2.56.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.ip": "true"
},
"x-f5xc-example": "192.0.2.56",
"x-validation-rules": {
"ves.io.schema.rules.string.ip": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Input message of the 'DeAllocateIP' RPC.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for giaDeallocateIPRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for giaDeallocateIPRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "message",
"type": "string",
"description": "Message from global IP allocator."
}
]
}
]
},
	"global-log-receivers": {
"name": "global-log-receivers",
"displayName": "Global Log Receivers",
"operations": [
{
"name": "create_global_log_receiver",
"description": "Create Global Log Receiver.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/global_log_receivers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of global_log_receiver",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.global_log_receiver.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/global_log_receiverCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Global log receiver for F5 XC centralized logging",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "log_type",
"fields": [
"spec.audit_logs",
"spec.dns_logs",
"spec.request_logs",
"spec.security_events"
],
"required": true,
"reason": "Choose exactly one log type"
},
{
"name": "receiver",
"fields": [
"spec.aws_cloud_watch_receiver",
"spec.azure_event_hubs_receiver",
"spec.azure_receiver",
"spec.datadog_receiver",
"spec.gcp_bucket_receiver",
"spec.http_receiver",
"spec.kafka_receiver",
"spec.new_relic_receiver",
"spec.qradar_receiver",
"spec.s3_receiver",
"spec.splunk_receiver",
"spec.sumo_logic_receiver"
],
"required": true,
"reason": "Choose exactly one receiver type"
}
],
"example_yaml": "metadata:\n  name: example-log-receiver\n  namespace: system\nspec:\n  request_logs: {}\n  http_receiver:\n    uri: http://logs.example.com/ingest\n",
"example_json": "{\n  \"metadata\": {\"name\": \"example-log-receiver\", \"namespace\": \"system\"},\n  \"spec\": {\n    \"request_logs\": {},\n    \"http_receiver\": {\"uri\": \"http://logs.example.com/ingest\"}\n  }\n}\n"
},
"x-f5xc-cli-domain": "log"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-log-receiver",
"namespace": "system"
},
"spec": {
"request_logs": {},
"http_receiver": {
"uri": "http://logs.example.com/ingest"
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Global log receiver for F5 XC centralized logging"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new Global Log Receiver object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.audit_logs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver": {
"type": "object",
"description": "AWS Cloudwatch Logs Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.aws_region": {
"type": "string",
"description": "AWS Region Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.group_name": {
"type": "string",
"description": "The group name of the target Cloudwatch Logs stream.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 512,
"pattern": "^[\\\\.\\\\-_/#A-Za-z0-9]+$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.stream_name": {
"type": "string",
"description": "The stream name of the target Cloudwatch Logs stream.\nNote that there can only be one writer to a log stream at a time.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 512,
"pattern": "^[^:*]*$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver": {
"type": "object",
"description": "Azure Event Hubs Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver.connection_string": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver.instance": {
"type": "string",
"description": "Event Hubs Instance name into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver.namespace": {
"type": "string",
"description": "Event Hubs Namespace is namespace with instance into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_receiver": {
"type": "object",
"description": "Azure Blob Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.connection_string": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.container_name": {
"type": "string",
"description": "Container Name is the name of the container into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_receiver.filename_options": {
"type": "object",
"description": "Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver": {
"type": "object",
"description": "Configuration for Datadog endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.datadog_api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.endpoint": {
"type": "string",
"description": "Exclusive with [site]\nDatadog Endpoint,.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.site": {
"type": "string",
"description": "Exclusive with [endpoint]\nDatadog Site,.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_logs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver": {
"type": "object",
"description": "GCP Bucket Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.bucket": {
"type": "string",
"description": "GCP Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.filename_options": {
"type": "object",
"description": "Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.gcp_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver": {
"type": "object",
"description": "Configuration for HTTP endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_basic": {
      "type": "object",
"description": "Authentication parameters to access HTPP Log Receiver Endpoint.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_token": {
      "type": "object",
"description": "Authentication Token for access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.uri": {
"type": "string",
"description": "HTTP URI is the URI of the HTTP endpoint to send logs to,.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver": {
"type": "object",
"description": "Kafka Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.bootstrap_servers": {
"type": "array",
"description": "List of host:port pairs of the Kafka brokers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kafka_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.kafka_topic": {
"type": "string",
"description": "The Kafka topic name to write events to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9\\\\._\\\\-]+$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kafka_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver": {
"type": "object",
"description": "Configuration for NewRelic endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver.api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver.eu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver.us": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_current": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_list": {
"type": "object",
"description": "Namespace List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_list.namespaces": {
"type": "array",
"description": "List of namespaces to stream logs for.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.qradar_receiver": {
"type": "object",
"description": "Configuration for IBM QRadar endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.uri": {
"type": "string",
"description": "Log Source Collector URL is the URL of the IBM QRadar Log Source Collector to send logs to,.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.qradar_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_logs": {
"type": "object",
"description": "Configuration for request logs with sampling choice.\nAllows selection between sampled (default) or unsampled (full) request logs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_logs.sampled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_logs.unsampled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver": {
"type": "object",
"description": "S3 Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_region": {
"type": "string",
"description": "AWS Region Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.bucket": {
"type": "string",
"description": "S3 Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.filename_options": {
"type": "object",
"description": "Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.security_events": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver": {
"type": "object",
"description": "Configuration for Splunk HEC Logs endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.endpoint": {
"type": "string",
"description": "Splunk HEC Logs Endpoint,\n(Note: must not contain `/services/collector`)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.splunk_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.splunk_hec_token": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sumo_logic_receiver": {
"type": "object",
"description": "Configuration for SumoLogic endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sumo_logic_receiver.url": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.filter_choice": [
"ns_all",
"ns_current",
"ns_list"
],
"spec.log_type": [
"audit_logs",
"dns_logs",
"request_logs",
"security_events"
],
"spec.receiver": [
"aws_cloud_watch_receiver",
"azure_event_hubs_receiver",
"azure_receiver",
"datadog_receiver",
"gcp_bucket_receiver",
"http_receiver",
"kafka_receiver",
"new_relic_receiver",
"qradar_receiver",
"s3_receiver",
"splunk_receiver",
"sumo_logic_receiver"
],
"spec.aws_cloud_watch_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.aws_cloud_watch_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.aws_cloud_watch_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.aws_cloud_watch_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.azure_event_hubs_receiver.connection_string.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.azure_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.azure_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.azure_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.azure_receiver.connection_string.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_receiver.filename_options.folder": [
"custom_folder",
"log_type_folder",
"no_folder"
],
"spec.datadog_receiver.endpoint_choice": [
"endpoint",
"site"
],
"spec.datadog_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.datadog_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.datadog_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.datadog_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.datadog_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.datadog_receiver.datadog_api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.datadog_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.datadog_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.datadog_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.datadog_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.gcp_bucket_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.gcp_bucket_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.gcp_bucket_receiver.filename_options.folder": [
"custom_folder",
"log_type_folder",
"no_folder"
],
"spec.http_receiver.auth_choice": [
      "auth_basic",
      "auth_none",
      "auth_token"
      ],
"spec.http_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.http_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.http_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.http_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.http_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.http_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.http_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.http_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.http_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.kafka_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.kafka_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.kafka_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.kafka_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.kafka_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.kafka_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.kafka_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.kafka_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.kafka_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.new_relic_receiver.endpoint_choice": [
"eu",
"us"
],
"spec.new_relic_receiver.api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.qradar_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.qradar_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.qradar_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.qradar_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.qradar_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.qradar_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.qradar_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.qradar_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.qradar_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.request_logs.sampling_choice": [
"sampled",
"unsampled"
],
"spec.s3_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.s3_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.s3_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.s3_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.s3_receiver.filename_options.folder": [
"custom_folder",
"log_type_folder",
"no_folder"
],
"spec.splunk_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.splunk_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.splunk_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.splunk_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.splunk_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.splunk_receiver.splunk_hec_token.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.splunk_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.splunk_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.splunk_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.splunk_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.sumo_logic_receiver.url.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_global_log_receiver",
"description": "Replace Global Log Receiver.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/global_log_receivers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a global_log_receiver",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.global_log_receiver.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/global_log_receiverReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Global log receiver for F5 XC centralized logging",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "log_type",
"fields": [
"spec.audit_logs",
"spec.dns_logs",
"spec.request_logs",
"spec.security_events"
],
"required": true,
"reason": "Choose exactly one log type"
},
{
"name": "receiver",
"fields": [
"spec.aws_cloud_watch_receiver",
"spec.azure_event_hubs_receiver",
"spec.azure_receiver",
"spec.datadog_receiver",
"spec.gcp_bucket_receiver",
"spec.http_receiver",
"spec.kafka_receiver",
"spec.new_relic_receiver",
"spec.qradar_receiver",
"spec.s3_receiver",
"spec.splunk_receiver",
"spec.sumo_logic_receiver"
],
"required": true,
"reason": "Choose exactly one receiver type"
}
],
"example_yaml": "metadata:\n  name: example-log-receiver\n  namespace: system\nspec:\n  request_logs: {}\n  http_receiver:\n    uri: http://logs.example.com/ingest\n",
"example_json": "{\n  \"metadata\": {\"name\": \"example-log-receiver\", \"namespace\": \"system\"},\n  \"spec\": {\n    \"request_logs\": {},\n    \"http_receiver\": {\"uri\": \"http://logs.example.com/ingest\"}\n  }\n}\n"
},
"x-f5xc-cli-domain": "log"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-log-receiver",
"namespace": "system"
},
"spec": {
"request_logs": {},
"http_receiver": {
"uri": "http://logs.example.com/ingest"
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Global log receiver for F5 XC centralized logging"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of an Global Log Receiver object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.audit_logs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver": {
"type": "object",
"description": "AWS Cloudwatch Logs Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.aws_region": {
"type": "string",
"description": "AWS Region Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.group_name": {
"type": "string",
"description": "The group name of the target Cloudwatch Logs stream.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 512,
"pattern": "^[\\\\.\\\\-_/#A-Za-z0-9]+$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.aws_cloud_watch_receiver.stream_name": {
"type": "string",
"description": "The stream name of the target Cloudwatch Logs stream.\nNote that there can only be one writer to a log stream at a time.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 512,
"pattern": "^[^:*]*$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver": {
"type": "object",
"description": "Azure Event Hubs Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver.connection_string": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver.instance": {
"type": "string",
"description": "Event Hubs Instance name into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_event_hubs_receiver.namespace": {
"type": "string",
"description": "Event Hubs Namespace is namespace with instance into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_receiver": {
"type": "object",
"description": "Azure Blob Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.connection_string": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure_receiver.container_name": {
"type": "string",
"description": "Container Name is the name of the container into which logs should be stored.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 63,
"pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.azure_receiver.filename_options": {
"type": "object",
"description": "Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver": {
"type": "object",
"description": "Configuration for Datadog endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.datadog_api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.endpoint": {
"type": "string",
"description": "Exclusive with [site]\nDatadog Endpoint,.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.site": {
"type": "string",
"description": "Exclusive with [endpoint]\nDatadog Site,.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.datadog_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_logs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver": {
"type": "object",
"description": "GCP Bucket Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.bucket": {
"type": "string",
"description": "GCP Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.filename_options": {
"type": "object",
"description": "Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp_bucket_receiver.gcp_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver": {
"type": "object",
"description": "Configuration for HTTP endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_basic": {
      "type": "object",
"description": "Authentication parameters to access HTPP Log Receiver Endpoint.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.auth_token": {
      "type": "object",
"description": "Authentication Token for access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_receiver.uri": {
"type": "string",
"description": "HTTP URI is the URI of the HTTP endpoint to send logs to,.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver": {
"type": "object",
"description": "Kafka Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.bootstrap_servers": {
"type": "array",
"description": "List of host:port pairs of the Kafka brokers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kafka_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.kafka_topic": {
"type": "string",
"description": "The Kafka topic name to write events to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9\\\\._\\\\-]+$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.kafka_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kafka_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver": {
"type": "object",
"description": "Configuration for NewRelic endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver.api_key": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver.eu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.new_relic_receiver.us": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_current": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_list": {
"type": "object",
"description": "Namespace List.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ns_list.namespaces": {
"type": "array",
"description": "List of namespaces to stream logs for.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.qradar_receiver": {
"type": "object",
"description": "Configuration for IBM QRadar endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.qradar_receiver.uri": {
"type": "string",
"description": "Log Source Collector URL is the URL of the IBM QRadar Log Source Collector to send logs to,.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.qradar_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_logs": {
"type": "object",
"description": "Configuration for request logs with sampling choice.\nAllows selection between sampled (default) or unsampled (full) request logs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_logs.sampled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_logs.unsampled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver": {
"type": "object",
"description": "S3 Configuration for Global Log Receiver.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.aws_region": {
"type": "string",
"description": "AWS Region Name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.bucket": {
"type": "string",
"description": "S3 Bucket Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 3,
"maxLength": 128,
"pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.s3_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.s3_receiver.filename_options": {
"type": "object",
"description": "Filename OPTIONS allow customization of filename and folder paths used by a destination endpoint bucket or file.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.security_events": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver": {
"type": "object",
"description": "Configuration for Splunk HEC Logs endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.batch": {
"type": "object",
"description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.compression": {
"type": "object",
"description": "Compression Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.endpoint": {
"type": "string",
"description": "Splunk HEC Logs Endpoint,\n(Note: must not contain `/services/collector`)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^https?://[^\\s/$.?#].[^\\s]*$",
"format": "uri",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.splunk_receiver.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.splunk_hec_token": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.splunk_receiver.use_tls": {
"type": "object",
"description": "TLS Parameters for client connection to the endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sumo_logic_receiver": {
"type": "object",
"description": "Configuration for SumoLogic endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sumo_logic_receiver.url": {
"type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.filter_choice": [
"ns_all",
"ns_current",
"ns_list"
],
"spec.log_type": [
"audit_logs",
"dns_logs",
"request_logs",
"security_events"
],
"spec.receiver": [
"aws_cloud_watch_receiver",
"azure_event_hubs_receiver",
"azure_receiver",
"datadog_receiver",
"gcp_bucket_receiver",
"http_receiver",
"kafka_receiver",
"new_relic_receiver",
"qradar_receiver",
"s3_receiver",
"splunk_receiver",
"sumo_logic_receiver"
],
"spec.aws_cloud_watch_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.aws_cloud_watch_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.aws_cloud_watch_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.aws_cloud_watch_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.azure_event_hubs_receiver.connection_string.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.azure_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.azure_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.azure_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.azure_receiver.connection_string.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.azure_receiver.filename_options.folder": [
"custom_folder",
"log_type_folder",
"no_folder"
],
"spec.datadog_receiver.endpoint_choice": [
"endpoint",
"site"
],
"spec.datadog_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.datadog_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.datadog_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.datadog_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.datadog_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.datadog_receiver.datadog_api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.datadog_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.datadog_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.datadog_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.datadog_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.gcp_bucket_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.gcp_bucket_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.gcp_bucket_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.gcp_bucket_receiver.filename_options.folder": [
"custom_folder",
"log_type_folder",
"no_folder"
],
"spec.http_receiver.auth_choice": [
      "auth_basic",
      "auth_none",
      "auth_token"
      ],
"spec.http_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.http_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.http_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.http_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.http_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.http_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.http_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.http_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.http_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.kafka_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.kafka_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.kafka_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.kafka_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.kafka_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.kafka_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.kafka_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.kafka_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.kafka_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.new_relic_receiver.endpoint_choice": [
"eu",
"us"
],
"spec.new_relic_receiver.api_key.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.qradar_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.qradar_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.qradar_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.qradar_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.qradar_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.qradar_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.qradar_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.qradar_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.qradar_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.request_logs.sampling_choice": [
"sampled",
"unsampled"
],
"spec.s3_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.s3_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.s3_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.s3_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.s3_receiver.filename_options.folder": [
"custom_folder",
"log_type_folder",
"no_folder"
],
"spec.splunk_receiver.tls_choice": [
"no_tls",
"use_tls"
],
"spec.splunk_receiver.batch.batch_bytes": [
"max_bytes",
"max_bytes_disabled"
],
"spec.splunk_receiver.batch.batch_events": [
"max_events",
"max_events_disabled"
],
"spec.splunk_receiver.batch.batch_timeout": [
"timeout_seconds",
"timeout_seconds_default"
],
"spec.splunk_receiver.compression.compression_choice": [
"compression_default",
"compression_gzip",
"compression_none"
],
"spec.splunk_receiver.splunk_hec_token.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.splunk_receiver.use_tls.ca_choice": [
"no_ca",
"trusted_ca_url"
],
"spec.splunk_receiver.use_tls.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.splunk_receiver.use_tls.verify_certificate": [
"disable_verify_certificate",
"enable_verify_certificate"
],
"spec.splunk_receiver.use_tls.verify_hostname": [
"disable_verify_hostname",
"enable_verify_hostname"
],
"spec.sumo_logic_receiver.url.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
},
{
"name": "list_global_log_receivers",
"description": "List Global Log Receiver.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/global_log_receivers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_global_log_receiver",
"description": "DELETE Global Log Receiver.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/global_log_receivers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a global_log_receiver",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.global_log_receiver.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for global_log_receiverDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for global_log_receiverDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "log"
}
},
{
"name": "get_global_log_receiver",
"description": "GET Global Log Receiver.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/global_log_receivers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"global-networks": {
"name": "global-networks",
"displayName": "Global Networks",
"operations": [
{
"name": "list_global_networks",
"description": "Global Network List.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sites/{site}/global_networks",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of the global networks connected to site."
}
]
}
]
},
	"graph": {
"name": "graph",
"displayName": "Graph",
"operations": [
{
"name": "create_graph",
"description": "Segment",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/segments/graph",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to specify filters, group by, metric selectors etc for segments.",
"title": "Segments Request",
"x-displayname": "Segments Request.",
"x-ves-proto-message": "ves.io.schema.segment.SegmentsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/schemasegmentFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by given group by.\n\nOptional: If not specified, then the data is aggregated/grouped by segment_name.",
"title": "group_by",
"items": {
"$ref": "#/components/schemas/schemasegmentLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by given group by. Optional: If not specified, then the data is aggregated/grouped by segment_name.",
"x-f5xc-description-medium": "Aggregate data by given group by. Optional: If not specified, then the data is aggregated/grouped by segment_name.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, segment data for all segments will be returned in the response.",
      "title": "label_filter",
"items": {
"$ref": "#/components/schemas/schemasegmentLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, segment data for all segments will be returned in the response.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build response.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build response.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build response. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to specify filters, group by, metric selectors etc for segments.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for segmentSegmentsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for segmentSegmentsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for segmentSegmentsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "FieldSelector is used to specify the list of fields to be returned in the response for segments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge_metric_type": {
"type": "array",
"description": "Field Selector for edge.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node_metric_type": {
"type": "array",
"description": "Field Selector for node.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by given group by.\n\nOptional: If not specified, then the data is aggregated/grouped by segment_name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, segment data for all segments will be returned in the response.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build response.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "Data for different metric types for all segments."
},
{
"field": "nodes",
"type": "array",
"description": "Data for different metric types for all segments."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"graph-all-ns-service": {
"name": "graph-all-ns-service",
"displayName": "Graph All Ns Service",
"operations": [
{
"name": "create_graph_all_ns_service",
"description": "Service Graph Query All Namespaces.",
"method": "POST",
"path": "/api/data/namespaces/system/graph/all_ns_service",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Graph/service API is used to GET service mesh graph of related services.",
      "title": "Service Graph Request",
"x-displayname": "Service Graph Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.Request",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/serviceFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of namespace, site, service, app_type and vhost.\n\nOptional: If not specified, then the data is aggregated/grouped by namespace and service.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/serviceIdField"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by any or all of namespace, site, service, app_type and vhost.",
"x-f5xc-description-medium": "Aggregate data by any or all of namespace, site, service, app_type and vhost. Optional: If not specified, then the data is aggregated/grouped by namespace and service.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"format": "boolean",
"x-displayname": "Trend calculation requested by the user.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid\naggregation across all app_types for the given namespace.",
      "title": "Label Filter",
"items": {
"$ref": "#/components/schemas/serviceLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid aggregation across all...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Graph/service API is used to GET service mesh graph of related services.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for serviceRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "FieldSelector is used to specify the list of fields to be returned in the response for site graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.api_endpoint": {
      "type": "object",
"description": "Selector for API Endpoints.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of namespace, site, service, app_type and vhost.\n\nOptional: If not specified, then the data is aggregated/grouped by namespace and service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid\naggregation across all app_types for the given namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"health-status": {
"name": "health-status",
"displayName": "Health Status",
"operations": [
{
"name": "list_health_status",
"description": "Discovered Service Health Status.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/discovered_services/{name}/health_status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "status",
"type": "array",
"description": "Health Status of Discovered Service."
},
{
"field": "virtual_server_pool_members_health",
"type": "object",
"description": ""
}
]
}
]
},
	"healthchecks": {
"name": "healthchecks",
"displayName": "Healthchecks",
"operations": [
{
"name": "create_healthcheck",
"description": "Create Health Check.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/healthchecks",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of healthcheck",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.healthcheck.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/healthcheckCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Health check configuration for monitoring origin servers",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.interval",
"spec.timeout",
"spec.healthy_threshold",
"spec.unhealthy_threshold"
],
"mutually_exclusive_groups": [
{
"name": "health_check",
"fields": [
"spec.http_health_check",
"spec.tcp_health_check",
"spec.udp_icmp_health_check"
],
"required": true,
"reason": "Choose exactly one health check type"
}
],
"example_yaml": "apiVersion: v1\nkind: healthcheck\nmetadata:\n  name: http-health\n  namespace: default\nspec:\n  http_health_check:\n    path: /health\n    use_origin_server_name: {}\n  interval: 15\n  timeout: 3\n  unhealthy_threshold: 1\n  healthy_threshold: 3\n  jitter_percent: 30\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"http-health\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"http_health_check\": {\"path\": \"/health\", \"use_origin_server_name\": {}},\n    \"interval\": 15,\n    \"timeout\": 3,\n    \"unhealthy_threshold\": 1,\n    \"healthy_threshold\": 3,\n    \"jitter_percent\": 30\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "http-health",
"namespace": "default"
},
"spec": {
"http_health_check": {
"path": "/health",
"use_origin_server_name": {}
},
"interval": 15,
"timeout": 3,
"unhealthy_threshold": 1,
"healthy_threshold": 3,
"jitter_percent": 30
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.interval",
"spec.timeout",
"spec.healthy_threshold",
"spec.unhealthy_threshold"
],
"description": "Health check configuration for monitoring origin servers"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.healthy_threshold": {
"type": "integer",
"description": "Number of successful responses before declaring healthy. In other words, this is\nthe number of healthy health checks required before a host is marked\nhealthy. Note that during startup, only a single successful health check is\nrequired to mark a host healthy.",
"constraints": {
"constraintType": "number",
"category": "threshold",
"minimum": 1,
"maximum": 16,
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "threshold",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_health_check": {
"type": "object",
"description": "Healthy if \"GET\" method on URL \"HTTP(s)://<host>/<path>\" with optional \"<header>\" returns success.\n\"host\" is not used for DNS resolution. It is used as HTTP Header in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.expected_response": {
"type": "string",
"description": "Raw bytes expected in the response of HTTP health check. Input is to be given in Hex encoded format.\nIf left empty, then response body is not considered for evaluating health check status.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.expected_status_codes": {
"type": "array",
"description": "Specifies a list of HTTP response status codes considered healthy. To treat default HTTP expected\nstatus code 200 as healthy, user has to configure it explicitly. This is a list of strings, each\nof which is single HTTP status code or a range with start and end values separated by \"-\".",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.headers": {
"type": "object",
"description": "Specifies a list of HTTP headers that should be added to each request that is sent to the\nhealth checked cluster. This is a list of key-value pairs.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.host_header": {
"type": "string",
"description": "Exclusive with [use_origin_server_name]\nThe value of the host header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 262,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.path": {
"type": "string",
"description": "Specifies the HTTP path that will be requested during health checking.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_health_check.request_headers_to_remove": {
"type": "array",
"description": "Specifies a list of HTTP headers that should be removed from each request that is sent to the\nhealth checked cluster. This is a list of keys of headers.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.use_http2": {
"type": "boolean",
"description": "If set, health checks will be made using HTTP/2.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.use_origin_server_name": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval": {
"type": "integer",
"description": "Time interval in seconds between two healthcheck requests.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 600,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.jitter_percent": {
"type": "integer",
"description": "Add a random amount of time as a percent value to the interval between successive healthcheck requests.",
"constraints": {
"constraintType": "number",
"category": "timing",
"ranges": [
{
"minimum": 0,
"maximum": 0
},
{
"minimum": 10,
"maximum": 50
}
],
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "timing",
"note": "Non-contiguous: {0} union [10, 50] — values 1-9 rejected by API",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check": {
"type": "object",
"description": "Healthy if TCP connection is successful and response payload matches <expected_response>",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.expected_response": {
"type": "string",
"description": "Raw bytes expected in the request. Describes the encoding of the payload bytes in the payload.\nHex encoded payload.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.send_payload": {
"type": "string",
"description": "Raw bytes sent in the request. Empty payloads imply a connect-only health check.\nDescribes the encoding of the payload bytes in the payload.\nHex encoded payload.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timeout": {
"type": "integer",
"description": "Timeout in seconds to wait for successful response. In other words, it is\nthe time to wait for a health check response. If the timeout is reached the\nhealth check attempt will be considered a failure.",
"constraints": {
"constraintType": "number",
"category": "timing",
"minimum": 1,
"maximum": 600,
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "timing",
"note": "API rejects timeout > 600 for healthchecks (global pattern says 3600)",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.udp_icmp_health_check": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.unhealthy_threshold": {
"type": "integer",
"description": "Number of failed responses before declaring unhealthy. In other words, this is\nthe number of unhealthy health checks required before a host is marked\nunhealthy. Note that for HTTP health checking if a host responds with 503\nthis threshold is ignored and the host is considered unhealthy immediately.",
"constraints": {
"constraintType": "number",
"category": "threshold",
"minimum": 1,
"maximum": 16,
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "threshold",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.health_check": [
"http_health_check",
"tcp_health_check",
"udp_icmp_health_check"
],
"spec.http_health_check.host_header_choice": [
"host_header",
"use_origin_server_name"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_healthcheck",
"description": "Replace Health Check.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/healthchecks/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a healthcheck",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.healthcheck.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/healthcheckReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Health check configuration for monitoring origin servers",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.interval",
"spec.timeout",
"spec.healthy_threshold",
"spec.unhealthy_threshold"
],
"mutually_exclusive_groups": [
{
"name": "health_check",
"fields": [
"spec.http_health_check",
"spec.tcp_health_check",
"spec.udp_icmp_health_check"
],
"required": true,
"reason": "Choose exactly one health check type"
}
],
"example_yaml": "apiVersion: v1\nkind: healthcheck\nmetadata:\n  name: http-health\n  namespace: default\nspec:\n  http_health_check:\n    path: /health\n    use_origin_server_name: {}\n  interval: 15\n  timeout: 3\n  unhealthy_threshold: 1\n  healthy_threshold: 3\n  jitter_percent: 30\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"http-health\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"http_health_check\": {\"path\": \"/health\", \"use_origin_server_name\": {}},\n    \"interval\": 15,\n    \"timeout\": 3,\n    \"unhealthy_threshold\": 1,\n    \"healthy_threshold\": 3,\n    \"jitter_percent\": 30\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "http-health",
"namespace": "default"
},
"spec": {
"http_health_check": {
"path": "/health",
"use_origin_server_name": {}
},
"interval": 15,
"timeout": 3,
"unhealthy_threshold": 1,
"healthy_threshold": 3,
"jitter_percent": 30
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.interval",
"spec.timeout",
"spec.healthy_threshold",
"spec.unhealthy_threshold"
],
"description": "Health check configuration for monitoring origin servers"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.healthy_threshold": {
"type": "integer",
"description": "Number of successful responses before declaring healthy. In other words, this is\nthe number of healthy health checks required before a host is marked\nhealthy. Note that during startup, only a single successful health check is\nrequired to mark a host healthy.",
"constraints": {
"constraintType": "number",
"category": "threshold",
"minimum": 1,
"maximum": 16,
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "threshold",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_health_check": {
"type": "object",
"description": "Healthy if \"GET\" method on URL \"HTTP(s)://<host>/<path>\" with optional \"<header>\" returns success.\n\"host\" is not used for DNS resolution. It is used as HTTP Header in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.expected_response": {
"type": "string",
"description": "Raw bytes expected in the response of HTTP health check. Input is to be given in Hex encoded format.\nIf left empty, then response body is not considered for evaluating health check status.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.expected_status_codes": {
"type": "array",
"description": "Specifies a list of HTTP response status codes considered healthy. To treat default HTTP expected\nstatus code 200 as healthy, user has to configure it explicitly. This is a list of strings, each\nof which is single HTTP status code or a range with start and end values separated by \"-\".",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.headers": {
"type": "object",
"description": "Specifies a list of HTTP headers that should be added to each request that is sent to the\nhealth checked cluster. This is a list of key-value pairs.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.host_header": {
"type": "string",
"description": "Exclusive with [use_origin_server_name]\nThe value of the host header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 262,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.path": {
"type": "string",
"description": "Specifies the HTTP path that will be requested during health checking.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.http_health_check.request_headers_to_remove": {
"type": "array",
"description": "Specifies a list of HTTP headers that should be removed from each request that is sent to the\nhealth checked cluster. This is a list of keys of headers.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.use_http2": {
"type": "boolean",
"description": "If set, health checks will be made using HTTP/2.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_health_check.use_origin_server_name": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval": {
"type": "integer",
"description": "Time interval in seconds between two healthcheck requests.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 600,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.jitter_percent": {
"type": "integer",
"description": "Add a random amount of time as a percent value to the interval between successive healthcheck requests.",
"constraints": {
"constraintType": "number",
"category": "timing",
"ranges": [
{
"minimum": 0,
"maximum": 0
},
{
"minimum": 10,
"maximum": 50
}
],
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "timing",
"note": "Non-contiguous: {0} union [10, 50] — values 1-9 rejected by API",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check": {
"type": "object",
"description": "Healthy if TCP connection is successful and response payload matches <expected_response>",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.expected_response": {
"type": "string",
"description": "Raw bytes expected in the request. Describes the encoding of the payload bytes in the payload.\nHex encoded payload.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp_health_check.send_payload": {
"type": "string",
"description": "Raw bytes sent in the request. Empty payloads imply a connect-only health check.\nDescribes the encoding of the payload bytes in the payload.\nHex encoded payload.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hex",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timeout": {
"type": "integer",
"description": "Timeout in seconds to wait for successful response. In other words, it is\nthe time to wait for a health check response. If the timeout is reached the\nhealth check attempt will be considered a failure.",
"constraints": {
"constraintType": "number",
"category": "timing",
"minimum": 1,
"maximum": 600,
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "timing",
"note": "API rejects timeout > 600 for healthchecks (global pattern says 3600)",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.udp_icmp_health_check": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.unhealthy_threshold": {
"type": "integer",
"description": "Number of failed responses before declaring unhealthy. In other words, this is\nthe number of unhealthy health checks required before a host is marked\nunhealthy. Note that for HTTP health checking if a host responds with 503\nthis threshold is ignored and the host is considered unhealthy immediately.",
"constraints": {
"constraintType": "number",
"category": "threshold",
"minimum": 1,
"maximum": 16,
"multipleOf": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "threshold",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.health_check": [
"http_health_check",
"tcp_health_check",
"udp_icmp_health_check"
],
"spec.http_health_check.host_header_choice": [
"host_header",
"use_origin_server_name"
]
}
},
{
"name": "list_healthchecks",
"description": "List Health Check.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/healthchecks",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_healthcheck",
"description": "DELETE Health Check.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/healthchecks/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a healthcheck",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.healthcheck.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for healthcheckDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for healthcheckDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
}
},
{
"name": "get_healthcheck",
"description": "GET Health Check.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/healthchecks/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"history": {
"name": "history",
"displayName": "History",
"operations": [
{
"name": "list_history",
"description": "GET Alerts History.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/alerts/history",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"alerts": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "alerts",
"type": "array",
"description": "List of alerts that matched the filter. Contains no more than 500 alerts per response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the response."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of alerts that matched the query."
}
]
}
]
},
	"history-aggregation": {
"name": "history-aggregation",
"displayName": "History Aggregation",
"operations": [
{
"name": "create_history_aggregation",
"description": "Alerts History Aggregation.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/alerts/history/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for alerts.",
"title": "Alerts History Aggregation Request",
"x-displayname": "Alerts History Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.alert.AlertsHistoryAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the alert response. If the number of alerts that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the alert response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the alert response. If the number of alerts that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch alerts whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "List of matchers to filter alert by.\nSyntax for filter := {[<matcher>]}\n<matcher> := <label_name><operator>\"<label_value>\"\n<label_name> := string\nAll alerts have the following default labels:\n\"alertname\", \"identifier\", \"group\", \"severity\"\n<label_value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : Select labels that are exactly equal to the provided string\n!= : Select labels that are not equal to the provided string.\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.",
"title": "filter",
"x-displayname": "Filter",
"x-ves-example": "{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}",
"x-f5xc-example": "\"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}\"",
"x-f5xc-description-medium": "List of matchers to filter alert by. Syntax for filter := {[<matcher>]} <matcher> := <label_name><operator>\"<label_value>\" <label_name> := string All alerts have the following default labels: \"alertname\", \"identifier\", \"group\", \"severity\" <label_value> := string <operator> :=...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of alerts.\nFor \"system\" namespace, all alerts for the tenant will be returned.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace to scope the listing of alerts. For \"system\" namespace, all alerts for the tenant will be returned.",
"x-f5xc-description-medium": "Namespace to scope the listing of alerts. For \"system\" namespace, all alerts for the tenant will be returned.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Fetch alerts whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch alerts whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch alerts whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for alerts.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alertAlertsHistoryAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alertAlertsHistoryAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alertAlertsHistoryAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the alert response. If the number of alerts that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch alerts whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "List of matchers to filter alert by.\nSyntax for filter := {[<matcher>]}\n<matcher> := <label_name><operator>\"<label_value>\"\n<label_name> := string\nAll alerts have the following default labels:\n\"alertname\", \"identifier\", \"group\", \"severity\"\n<label_value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : Select labels that are exactly equal to the provided string\n!= : Select labels that are not equal to the provided string.\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of alerts.\nFor \"system\" namespace, all alerts for the tenant will be returned.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch alerts whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the alerts response. If the number of alerts that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of alerts that matched the query."
}
]
}
]
},
	"history-scroll": {
"name": "history-scroll",
"displayName": "History Scroll",
"operations": [
{
"name": "list_history_scroll",
"description": "Alerts History Scroll.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/alerts/history/scroll",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "scroll_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"alerts": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "alerts",
"type": "array",
"description": "List of alerts that matched the filter. Contains no more than 500 alerts per response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the response."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of alerts that matched the query."
}
]
},
{
"name": "create_history_scroll",
"description": "Alerts History Scroll.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/alerts/history/scroll",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse\ncontaining no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the\nAlertsHistoryScrollRequest. Use the scroll_id returned in the AlertsHistoryResponse to fetch the next batch of alert messages and\none can continue this process till the scroll_id returned in the AlertsHistoryResponse is \"\" which indicates no more\nalert messages to scroll.",
"title": "Alerts History Scroll Request",
"x-displayname": "Alerts History Scroll Request.",
"x-ves-proto-message": "ves.io.schema.alert.AlertsHistoryScrollRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Fetch the alerts scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages.",
"title": "scroll_id",
"x-displayname": "Scroll ID",
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse containing no more than 500 alerts.",
"x-f5xc-description-medium": "Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse containing no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the AlertsHistoryScrollRequest. Use the scroll_id returned in the...",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alertAlertsHistoryScrollRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alertAlertsHistoryScrollRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"alerts": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alertAlertsHistoryScrollRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Fetch the alerts scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "alerts",
"type": "array",
"description": "List of alerts that matched the filter. Contains no more than 500 alerts per response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the response."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of alerts that matched the query."
}
]
}
]
},
	"hits": {
"name": "hits",
"displayName": "Hits",
"operations": [
{
"name": "create_hit",
"description": "Enhanced Firewall Policy Hits.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/enhanced_firewall_policy/hits",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the Enhanced Firewall Policy hits counter.",
"title": "Enhanced Firewall Policy Hits Request",
"x-displayname": "Enhanced Firewall Policy Hits Request.",
"x-ves-proto-message": "ves.io.schema.enhanced_firewall_policy.EnhancedFirewallPolicyHitsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels specified in group_by.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by POLICY.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/enhanced_firewall_policyEnhancedFirewallPolicyMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one of more labels specified in group_by. Optional: If not specified, then the rule hits are aggregated/grouped by POLICY.",
"x-f5xc-description-medium": "Aggregate data by one of more labels specified in group_by. Optional: If not specified, then the rule hits are aggregated/grouped by POLICY.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/enhanced_firewall_policyEnhancedFirewallPolicyMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope Enhanced Firewall Policy hits for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace is used to scope Enhanced Firewall Policy hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the Enhanced Firewall Policy hits counter.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for enhanced_firewall_policyEnhancedFirewallPolicyHitsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for enhanced_firewall_policyEnhancedFirewallPolicyHitsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for enhanced_firewall_policyEnhancedFirewallPolicyHitsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels specified in group_by.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by POLICY.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope Enhanced Firewall Policy hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of Enhanced Firewall Policy hits data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"hourly-usage-details": {
"name": "hourly-usage-details",
"displayName": "Hourly Usage Details",
"operations": [
{
"name": "create_hourly_usage_detail",
"description": "List hourly usage details.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/hourly_usage_details",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request body for ListHourlyUsageDetails rpc method.",
"title": "ListHourlyUsageDetailsReq",
"x-displayname": "List Hourly Usage Details Request.",
"x-ves-proto-message": "ves.io.schema.usage.ListHourlyUsageDetailsReq",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Encoded query which is passed as is to barracute daemon.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "{'MetricLabel':'label'}",
"x-f5xc-example": "{'MetricLabel':'label'}",
"x-f5xc-description-short": "Encoded query which is passed as is to barracute daemon.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request body for ListHourlyUsageDetails rpc method.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usageListHourlyUsageDetailsReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usageListHourlyUsageDetailsReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"hourly_usage_items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usageListHourlyUsageDetailsReq"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Encoded query which is passed as is to barracute daemon.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "hourly_usage_items",
"type": "array",
"description": "Array of usage by hour in the period from the query."
}
]
}
]
},
	"http-loadbalancers": {
"name": "http-loadbalancers",
"displayName": "Http Loadbalancers",
"operations": [
{
"name": "create_http_loadbalancer",
"description": "Create HTTP Load Balancer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of http_loadbalancer",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.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/viewshttp_loadbalancerCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.domains"
],
"mutually_exclusive_groups": [
{
"name": "lb_type",
"fields": [
"spec.http",
"spec.https",
"spec.https_auto_cert"
],
"reason": "Choose exactly one load balancer type"
},
{
"name": "advertising",
"fields": [
"spec.advertise_on_public_default_vip",
"spec.advertise_on_public",
"spec.advertise_custom",
"spec.do_not_advertise"
],
"reason": "Choose exactly one advertising method"
},
{
"name": "waf",
"fields": [
"spec.app_firewall",
"spec.disable_waf"
],
"reason": "WAF enabled or disabled"
},
{
"name": "bot_defense",
"fields": [
"spec.bot_defense",
"spec.bot_defense_advanced",
"spec.disable_bot_defense"
],
"reason": "Bot defense enabled or disabled"
},
{
"name": "rate_limit",
"fields": [
"spec.api_rate_limit",
      "spec.disable_rate_limit",
"spec.rate_limit"
],
"reason": "Rate limiting enabled or disabled"
},
{
"name": "api_discovery",
      "fields": [
"spec.disable_api_discovery",
      "spec.enable_api_discovery"
      ],
"reason": "API discovery enabled or disabled"
      },
{
"name": "api_testing",
      "fields": [
"spec.api_testing",
      "spec.disable_api_testing"
      ],
"reason": "API testing enabled or disabled"
      },
{
"name": "api_definition",
      "fields": [
"spec.api_specification",
      "spec.disable_api_definition"
      ],
"reason": "API definition enabled or disabled"
      },
{
"name": "malware_protection",
"fields": [
"spec.disable_malware_protection",
"spec.malware_protection_settings"
],
"reason": "Malware protection enabled or disabled"
},
{
"name": "client_side_defense",
"fields": [
"spec.client_side_defense",
"spec.disable_client_side_defense"
],
"reason": "Client-side defense enabled or disabled"
},
{
"name": "ip_reputation",
"fields": [
"spec.disable_ip_reputation",
"spec.enable_ip_reputation"
],
"reason": "IP reputation enabled or disabled"
},
{
"name": "threat_mesh",
"fields": [
"spec.disable_threat_mesh",
"spec.enable_threat_mesh"
],
"reason": "Threat mesh enabled or disabled"
},
{
"name": "malicious_user_detection",
"fields": [
"spec.disable_malicious_user_detection",
"spec.enable_malicious_user_detection"
],
"reason": "Malicious user detection enabled or disabled"
},
{
"name": "tls_config",
"fields": [
"spec.https_auto_cert.tls_config.default_security",
"spec.https_auto_cert.tls_config.medium_security",
"spec.https_auto_cert.tls_config.low_security",
"spec.https_auto_cert.tls_config.custom_security"
],
"reason": "Choose exactly one TLS security level"
},
{
"name": "mtls",
"fields": [
"spec.https_auto_cert.no_mtls",
"spec.https_auto_cert.use_mtls"
],
"reason": "Mutual TLS enabled or disabled"
},
{
"name": "server_name_header",
"fields": [
"spec.https_auto_cert.append_server_name",
"spec.https_auto_cert.default_header",
"spec.https_auto_cert.pass_through",
"spec.https_auto_cert.server_name"
],
"reason": "Choose exactly one server name header handling"
},
{
"name": "path_normalize",
"fields": [
"spec.https_auto_cert.enable_path_normalize",
"spec.https_auto_cert.disable_path_normalize"
],
"reason": "Path normalization enabled or disabled"
},
{
"name": "loadbalancer_choice",
"fields": [
"spec.https_auto_cert.non_default_loadbalancer",
"spec.https_auto_cert.default_loadbalancer"
],
"reason": "Choose default or non-default load balancer"
},
{
"name": "http_protocol",
"fields": [
"spec.https_auto_cert.http_protocol_options.http_protocol_enable_v1_only",
"spec.https_auto_cert.http_protocol_options.http_protocol_enable_v1_v2",
"spec.https_auto_cert.http_protocol_options.http_protocol_enable_v2_only"
],
"reason": "Choose exactly one HTTP protocol version configuration"
},
{
"name": "coalescing",
"fields": [
"spec.https_auto_cert.coalescing_options.default_coalescing",
"spec.https_auto_cert.coalescing_options.strict_coalescing"
],
"reason": "Choose exactly one connection coalescing option"
},
{
"name": "ddos_mitigation",
"fields": [
"spec.l7_ddos_protection.mitigation_block",
"spec.l7_ddos_protection.mitigation_captcha_challenge",
"spec.l7_ddos_protection.mitigation_js_challenge"
],
"reason": "Choose exactly one DDoS mitigation action"
},
{
"name": "ddos_rps_threshold",
"fields": [
"spec.l7_ddos_protection.default_rps_threshold",
"spec.l7_ddos_protection.rps_threshold"
],
"reason": "Choose default or custom RPS threshold"
},
{
"name": "ddos_clientside_action",
"fields": [
"spec.l7_ddos_protection.clientside_action_captcha_challenge",
"spec.l7_ddos_protection.clientside_action_js_challenge",
"spec.l7_ddos_protection.clientside_action_none"
],
"reason": "Choose exactly one client-side DDoS action"
},
{
"name": "ddos_policy",
"fields": [
"spec.l7_ddos_protection.ddos_policy_custom",
"spec.l7_ddos_protection.ddos_policy_none"
],
"reason": "DDoS policy reference or none"
},
{
"name": "challenge",
"fields": [
"spec.no_challenge",
"spec.js_challenge",
"spec.captcha_challenge",
"spec.enable_challenge",
"spec.policy_based_challenge"
],
"reason": "Choose exactly one challenge type"
},
{
"name": "user_identification",
"fields": [
"spec.user_id_client_ip",
"spec.user_identification"
],
"reason": "Choose user identification method"
},
{
"name": "client_ip_headers",
"fields": [
"spec.disable_trust_client_ip_headers",
"spec.enable_trust_client_ip_headers"
],
"reason": "Trust client IP headers or not"
},
{
"name": "service_policies_source",
"fields": [
"spec.service_policies_from_namespace",
"spec.active_service_policies",
"spec.no_service_policies"
],
"reason": "Service policies from namespace, active list, or none"
},
{
"name": "sensitive_data_policy",
"fields": [
"spec.default_sensitive_data_policy",
"spec.sensitive_data_policy"
],
"reason": "Use default or custom sensitive data policy"
},
{
"name": "load_balancing_algorithm",
"fields": [
"spec.least_active",
"spec.random",
"spec.ring_hash",
"spec.round_robin"
],
"reason": "Choose exactly one load balancing algorithm"
}
],
"example_yaml": "apiVersion: v1\nkind: http_loadbalancer\nmetadata:\n  name: example-app\n  namespace: default\nspec:\n  domains:\n    - example.com\n  https_auto_cert: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-app\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"domains\": [\"ar-test.example.com\"],\n    \"advertise_on_public_default_vip\": {},\n    \"http\": {\"port\": 80}\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-app",
"namespace": "default"
},
"spec": {
"domains": [
"ar-test.example.com"
],
"advertise_on_public_default_vip": {},
"http": {
"port": 80
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.domains"
],
"description": "HTTP/HTTPS load balancer for distributing traffic across origin pools"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the HTTP load balancer specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.add_location": {
"type": "boolean",
"description": "X-example: true\nAppends header x-F5 Distributed Cloud-location = <RE-site-name> in responses. This configuration\nis ignored on CE sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public.public_ip": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_protection_rules": {
      "type": "object",
"description": "API Protection Rules.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_protection_rules.api_endpoint_rules": {
      "type": "array",
"description": "This category defines specific rules per API endpoints.\nIf request matches any of these rules, skipping second category rules.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_protection_rules.api_groups_rules": {
      "type": "array",
"description": "This category includes rules per API group or Server URL.\nFor API groups, refer to API Definition which includes API groups derived from uploaded swaggers.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.api_endpoint_rules": {
      "type": "array",
"description": "Ordered endpoint-specific rate-limit rules. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.bypass_rate_limiting_rules": {
      "type": "object",
"description": "This category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.custom_ip_allowed_list": {
      "type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.ip_allowed_list": {
      "type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.no_ip_allowed_list": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.server_url_rules": {
      "type": "array",
"description": "Ordered domain or base-path rules for path-scoped rate limiting. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification": {
      "type": "object",
"description": "Settings for API specification (API definition, OpenAPI validation, etc.)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_all_spec_endpoints": {
      "type": "object",
"description": "Settings for API Inventory validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_custom_list": {
      "type": "object",
"description": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.\nAny other API-endpoint not listed will act according to \"Fall Through Mode\".",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.custom_header_value": {
      "type": "string",
"description": "Add x-F5-API-testing-identifier header value to prevent security flags on API testing traffic.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.domains": {
      "type": "array",
"description": "Add and configure testing domains and credentials.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.api_testing.every_day": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.every_month": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.every_week": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_clients": {
"type": "array",
"description": "Define rules to block IP Prefixes or AS numbers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.disable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.enable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.regional_endpoint": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- AUTO: AUTO\n\nAutomatic selection based on client IP address\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AUTO"
},
"spec.bot_defense.timeout": {
"type": "integer",
"description": "The timeout for the inference check, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 60000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced": {
"type": "object",
"description": "Bot Defense Advanced.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.disable_js_insert": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.disable_mobile_sdk": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.js_insert_all_pages": {
"type": "object",
"description": "Insert Bot Defense JavaScript in all pages.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.js_insert_all_pages_except": {
"type": "object",
"description": "Insert Bot Defense JavaScript in all pages with the exceptions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.js_insertion_rules": {
"type": "object",
"description": "This defines custom JavaScript insertion rules for Bot Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.mobile": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.mobile_sdk_config": {
"type": "object",
"description": "Mobile Request Identifier Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.web": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.caching_policy": {
"type": "object",
"description": "Caching Policies for the CDN.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.caching_policy.custom_cache_rule": {
"type": "object",
"description": "Caching policies for CDN.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.caching_policy.default_cache_action": {
"type": "object",
"description": "This defines a Default Cache Action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.captcha_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness": {
"type": "object",
"description": "Two types of cookie affinity:\n\n1. Passive. Takes a cookie that's present in the cookies header and\nhashes on its value.\n\n2. Generated. Generates and sets a cookie with an expiration (TTL)\non the first request from the client in its response to the client,\nbased on the endpoint the request gets sent to. The client then\npresents this on the next and all subsequent requests. The hash of\nthis is sufficient to ensure these requests GET sent to the same\nendpoint. The cookie is generated by hashing the source and\ndestination ports and addresses so that multiple independent HTTP2\nstreams on the same connection will independently receive the same\ncookie, even if they arrive simultaneously.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.add_httponly": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.add_secure": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ignore_httponly": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ignore_samesite": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ignore_secure": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.name": {
"type": "string",
"description": "The name of the cookie that will be used to obtain the hash key. If the\ncookie is not present and TTL below is not set, no hash will be\nproduced.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.path": {
"type": "string",
"description": "The name of the path for the cookie. If no path is specified here, no path\nwill be set for the cookie.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.samesite_lax": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.samesite_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.samesite_strict": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ttl": {
"type": "integer",
"description": "If specified, a cookie with the TTL will be generated if the cookie is\nnot present. If the TTL is present and zero, the generated cookie will\nbe a session cookie. TTL value is in milliseconds.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy": {
"type": "object",
"description": "Cross-Origin Resource Sharing requests configuration specified at Virtual-host or\nRoute level. Route level configuration takes precedence.\n\nAn example of an Cross origin HTTP request\nGET /resources/public-data/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nReferrer: http://foo.example/examples/access-control/simplexsinvocation.html\nOrigin: http://foo.example\n\nHTTP/1.1 200 OK\nDate: Mon, 01 Dec 2008 00:23:53 GMT\nServer: Apache/2.0.61\nAccess-Control-Allow-Origin: *\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive\nTransfer-Encoding: chunked\nContent-Type: application/XML\n\nAn example for cross origin HTTP OPTIONS request with Access-Control-Request-* header\n\nOPTIONS /resources/POST-here/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nOrigin: http://foo.example\nAccess-Control-Request-Method: POST\nAccess-Control-Request-Headers: X-PINGOTHER, Content-Type\n\nHTTP/1.1 204 No Content\nDate: Mon, 01 Dec 2008 01:15:39 GMT\nServer: Apache/2.0.61 (Unix)\nAccess-Control-Allow-Origin: http://foo.example\nAccess-Control-Allow-Methods: POST, GET, OPTIONS\nAccess-Control-Allow-Headers: X-PINGOTHER, Content-Type\nAccess-Control-Max-Age: 86400\nVary: Accept-Encoding, Origin\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_credentials": {
      "type": "boolean",
"description": "Specifies whether the resource allows credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_headers": {
"type": "string",
"description": "Specifies the content for the access-control-allow-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_methods": {
"type": "string",
"description": "Specifies the content for the access-control-allow-methods header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin": {
"type": "array",
"description": "Specifies the origins that will be allowed to do CORS requests.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin_regex": {
"type": "array",
"description": "Specifies regex patterns that match allowed origins.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.disabled": {
"type": "boolean",
"description": "Disable the CorsPolicy for a particular route. This is useful when\nvirtual-host has CorsPolicy, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.expose_headers": {
"type": "string",
"description": "Specifies the content for the access-control-expose-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.maximum_age": {
"type": "integer",
"description": "Specifies the content for the access-control-max-age header in seconds.\nThis indicates the maximum number of seconds the results can be cached\nA value of -1 will disable caching.\nMaximum permitted value is 86400 seconds (24 hours)",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy": {
"type": "object",
"description": "To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host.\n\n1. The origin that caused the user agent to issue the request (source origin).\n2. The origin that the request is going to (target origin).\nWhen the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid.\nBecause CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.all_load_balancer_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.custom_domain_list": {
"type": "object",
"description": "List of domain names used for Host header matching.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.data_guard_rules": {
"type": "array",
"description": "Data Guard prevents responses from exposing sensitive information by masking the data.\nThe system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*).\nNote: App Firewall should be enabled, to use Data Guard feature.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_mitigation_rules": {
"type": "array",
"description": "Define manual mitigation rules to block L7 DDoS attacks.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool": {
"type": "object",
"description": "Shape of the origin pool specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.advanced_options": {
"type": "object",
"description": "Configure Advanced OPTIONS for origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.automatic_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.endpoint_selection": {
"type": "string",
"description": "Policy for selection of endpoints from local site/remote site/both\n\nConsider both remote and local endpoints for load balancing\nLOCAL_ONLY: Consider only local endpoints for load balancing\nEnable this policy to load balance ONLY among locally discovered endpoints\nPrefer the local endpoints for load balancing. If local endpoints are not present\nremote endpoints will be considered.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISTRIBUTED"
},
"spec.default_pool.health_check_port": {
"type": "integer",
"description": "Exclusive with [same_as_endpoint_port]\nPort used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "networking",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "networking",
"note": "Asymmetry: port enforces [1,65535], health_check_port allows 0",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.healthcheck": {
"type": "array",
"description": "Reference to healthcheck configuration objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.lb_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.loadbalancer_algorithm": {
"type": "string",
"description": "Different load balancing algorithms supported\nWhen a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm\nto determine which host is selected.\n\n- ROUND_ROBIN: ROUND_ROBIN\n\nPolicy in which each healthy/available upstream endpoint is selected in round robin order.\n- LEAST_REQUEST: LEAST_REQUEST\n\nPolicy in which loadbalancer picks the upstream endpoint which has the fewest active requests\n- RING_HASH: RING_HASH\n\nPolicy implements consistent hashing to upstream endpoints using ring hash of endpoint names\nHash of the incoming request is calculated using request hash policy.\nThe ring/modulo hash load balancer implements consistent hashing to upstream hosts.\nThe algorithm is based on mapping all hosts onto a circle such that the addition or\nremoval of a host from the host set changes only affect 1/N requests. This technique\nis also commonly known as “ketama” hashing. A consistent hashing load balancer is only\neffective when protocol routing is used that specifies a value to hash on. The minimum\nring size governs the replication factor for each host in the ring. For example, if the\nminimum ring size is 1024 and there are 16 hosts, each host will be replicated 64 times.\n- RANDOM: RANDOM\n\nPolicy in which each available upstream endpoint is selected in random order.\nThe random load balancer selects a random healthy host. The random load balancer generally\nperforms better than round robin if no health checking policy is configured. Random selection\navoids bias towards the host in the set that comes after a failed host.\n- LB_OVERRIDE: Load Balancer Override\n\nHash policy is taken from from the load balancer which is using this origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ROUND_ROBIN"
},
"spec.default_pool.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.origin_servers": {
"type": "array",
"description": "List of origin servers in this pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.default_pool.port": {
"type": "integer",
"description": "Exclusive with [automatic_port lb_port]\nEndpoint service is available on this port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.same_as_endpoint_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.upstream_conn_pool_reuse_type": {
"type": "object",
"description": "Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.use_tls": {
"type": "object",
"description": "Upstream TLS Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.view_internal": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool_list": {
"type": "object",
"description": "List of Origin Pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool_list.pools": {
"type": "array",
"description": "List of Origin Pools.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_route_pools": {
"type": "array",
"description": "Origin Pools used when no route is specified (default route)",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sensitive_data_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_definition": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_testing": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_bot_defense": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_caching": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_client_side_defense": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ip_reputation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_malware_protection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_rate_limit": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_trust_client_ip_headers": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of Domains (host/authority header) that will be matched to load balancer.\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.\n\nDomains are also used for SNI matching if the Loadbalancer type is HTTPS.\nDomains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_api_discovery": {
      "type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_crawler": {
      "type": "object",
"description": "API Crawler message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_discovery_from_code_scan": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.custom_api_auth_discovery": {
      "type": "object",
"description": "API Discovery Advanced settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.default_api_auth_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.disable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.enable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge": {
"type": "object",
"description": "Configure auto mitigation i.e risk based challenges for malicious users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation": {
"type": "object",
"description": "List of IP threat categories.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation.ip_threat_categories": {
"type": "array",
"description": "If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_trust_client_ip_headers": {
"type": "object",
"description": "List of Client IP Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_trust_client_ip_headers.client_ip_headers": {
"type": "array",
"description": "Define the list of one or more Client IP Headers. Headers will be used in order from top to bottom, meaning\nif the first header is not present in the request, the system will proceed to check for the second header,\nand so on, until one of the listed headers is found. If none of the defined headers exist, or the value\nis not an IP address, then the system will use the source IP of the packet. If multiple defined headers with\ndifferent names are present in the request, the value of the first header name in the configuration will be used.\nIf multiple defined headers with the same name are present in the request, values of all those headers will be combined.\nThe system will read the right-most IP address from header, if there are multiple IP addresses in the header value.\nFor X-Forwarded-For header, the system will read the IP address(rightmost - 1), as the client IP.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 5,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.graphql_rules": {
"type": "array",
"description": "GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable\ndescription of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it\neasier to evolve APIs over time, and enables powerful developer tools. Policy configuration to analyze GraphQL\nqueries and prevent GraphQL tailored attacks.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nAs a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature\nor a DNS CNAME record should be created in your DNS provider's portal.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTP port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.append_server_name": {
"type": "string",
"description": "Exclusive with [default_header pass_through server_name]\nDefine the header value for the header name “server”.\nIf header value is already present, it is not overwritten and passed as-is.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.coalescing_options": {
"type": "object",
"description": "TLS connection coalescing configuration (not compatible with mTLS)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.connection_idle_timeout": {
"type": "integer",
"description": "The idle timeout for downstream connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 2 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.default_header": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.http_protocol_options": {
"type": "object",
"description": "HTTP protocol configuration OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.non_default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.pass_through": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTPS port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.server_name": {
"type": "string",
"description": "Exclusive with [append_server_name default_header pass_through]\nDefine the header value for the header name “server”.\nThis will overwrite existing values, if any, for the server header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.tls_cert_params": {
"type": "object",
"description": "Select TLS Parameters and Certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.tls_parameters": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.append_server_name": {
"type": "string",
"description": "Exclusive with [default_header pass_through server_name]\nDefine the header value for the header name “server”.\nIf header value is already present, it is not overwritten and passed as-is.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.coalescing_options": {
"type": "object",
"description": "TLS connection coalescing configuration (not compatible with mTLS)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.connection_idle_timeout": {
"type": "integer",
"description": "The idle timeout for downstream connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 2 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.default_header": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.http_protocol_options": {
"type": "object",
"description": "HTTP protocol configuration OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.no_mtls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.non_default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.pass_through": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTPS port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.server_name": {
"type": "string",
"description": "Exclusive with [append_server_name default_header pass_through]\nDefine the header value for the header name “server”.\nThis will overwrite existing values, if any, for the server header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.use_mtls": {
"type": "object",
"description": "Validation context for downstream client TLS connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.jwt_validation": {
"type": "object",
"description": "JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming\nJWTs before they are passed to your API origin. JWT Validation will also stop requests with expired\ntokens or tokens that are not yet valid.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.action": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.authorization_server": {
      "type": "object",
"description": "Reference to Authorization Server object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.jwks_config": {
"type": "object",
"description": "The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.mandatory_claims": {
"type": "object",
"description": "Configurable Validation of mandatory Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.reserved_claims": {
"type": "object",
"description": "Configurable Validation of reserved Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.target": {
"type": "object",
"description": "Define endpoints for which JWT token validation will be performed.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.token_location": {
      "type": "object",
"description": "Location of JWT in HTTP request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_block": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection": {
"type": "object",
"description": "L7 DDoS protection is critical for safeguarding web applications, APIs, and services that are exposed to the internet\nfrom sophisticated, volumetric, application-level threats. Configure actions, thresholds and policies to apply during\nL7 DDoS attack.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.clientside_action_captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.clientside_action_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.clientside_action_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.ddos_policy_custom": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.ddos_policy_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.default_rps_threshold": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.mitigation_block": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.mitigation_captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.mitigation_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.rps_threshold": {
"type": "integer",
"description": "Exclusive with [default_rps_threshold]\nConfigure custom RPS threshold.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 50000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.least_active": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.malware_protection_settings": {
"type": "object",
"description": "Malware Protection protects Web Apps and APIs, from malicious file uploads by scanning files in real-time.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.malware_protection_settings.malware_protection_rules": {
"type": "array",
"description": "Configure the match criteria to trigger Malware Protection Scan.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.more_option": {
"type": "object",
"description": "This defines various OPTIONS to define a route.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.buffer_policy": {
"type": "object",
"description": "Some upstream applications are not capable of handling streamed data. This config\nenables buffering the entire request before sending to upstream application. We can\nspecify the maximum buffer size and buffer interval with this config.\n\nBuffering can be enabled and disabled at VirtualHost and Route levels\nRoute level buffer configuration takes precedence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.compression_params": {
"type": "object",
"description": "Enables loadbalancer to compress dispatched data from an upstream service upon client request.\nThe content is compressed and then sent to the client with the appropriate headers if either response and request allow.\nOnly GZIP compression is supported.\n\nBy default compression will be skipped when:\n\nA request does NOT contain accept-encoding header.\nA request includes accept-encoding header, but it does not contain “gzip” or “*”.\nA request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress.\nA request whose accept-encoding header includes “identity”.\nA response contains a content-encoding header.\nA response contains a cache-control header whose value includes “no-transform”.\nA response contains a transfer-encoding header whose value includes “gzip”.\nA response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML.\nNeither content-length nor transfer-encoding headers are present in the response.\nResponse size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked).\n\nWhen compression is applied:\n\nThe content-length is removed from response headers.\nResponse headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header.\nThe “vary: accept-encoding” header is inserted on every response.\n\nGZIP Compression Level:\n\nA value which is optimal balance between speed of compression and amount of compression is chosen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.custom_errors": {
"type": "object",
"description": "Map of integer error codes as keys and string values that can be used to provide custom\nHTTP pages for each error code.\nKey of the map can be either response code class or HTTP Error code. Response code classes\nfor key is configured as follows\n3 -- for 3xx response code class\n4 -- for 4xx response code class\n5 -- for 5xx response code class\nValue of the map is string which represents custom HTTP responses.\nSpecific response code takes preference when both response code and response code class\nmatches for a request.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.disable_default_error_pages": {
"type": "boolean",
"description": "Disable the use of default F5XC error pages.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.idle_timeout": {
"type": "integer",
"description": "The amount of time that a stream can exist without upstream or downstream activity, in milliseconds.\nThe stream is terminated with a HTTP 504 (Gateway Timeout) error code if no upstream response header has been\nreceived, otherwise the stream is reset.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 3600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.max_request_header_size": {
"type": "integer",
"description": "The maximum request header size for downstream connections, in KiB.\nA HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size.\n\nIf multiple load balancers share the same advertise_policy, the highest value configured across all\nsuch load balancers is used for all the load balancers in question.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 96,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\nSets the maximum number of requests a downstream client can send\nover a single connection to Envoy.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_cookies_to_add": {
"type": "array",
"description": "Cookies are key-value pairs to be added to HTTP request being routed towards upstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_cookies_to_remove": {
"type": "array",
"description": "List of keys of Cookies to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP request being routed towards upstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_cookies_to_add": {
"type": "array",
"description": "Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_cookies_to_remove": {
"type": "array",
"description": "List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP response being sent towards downstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP response being sent towards downstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.multi_lb_app": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_server_subset_rule_list": {
"type": "object",
"description": "List of Origin Pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_server_subset_rule_list.origin_server_subset_rules": {
"type": "array",
"description": "Origin Server Subset Rules allow users to define match condition on Client (IP address, ASN, Country), IP Reputation, Regional Edge names,\nRequest for subset selection of origin servers. Origin Server Subset is a sequential engine where rules are evaluated one after the other.\nIt's important to define the correct order for Origin Server Subset to GET the intended result, rules are evaluated from top to bottom in the list.\nWhen an Origin server subset rule is matched, then this selection rule takes effect and no more rules are evaluated.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge": {
"type": "object",
"description": "Specifies the settings for policy rule based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_captcha_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_js_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_temporary_blocking_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.rule_list": {
"type": "object",
"description": "List of challenge rules to be used in policy based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.temporary_user_blocking": {
"type": "object",
"description": "Specifies configuration for temporary user blocking resulting from user behavior analysis.\n\nWhen Malicious User Mitigation is enabled from service policy rules, users' accessing the application will be analyzed for\nmalicious activity and the configured mitigation actions will be taken on identified malicious users.\nThese mitigation actions include setting up temporary blocking on that user.\nThis configuration specifies settings on how that blocking should be done by the loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protected_cookies": {
"type": "array",
"description": "Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses.\nCookie Tampering Protection prevents attackers from modifying the value of session cookies.\nFor Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite.\nThe configured mode of WAF (monitoring or blocking) will be enforced on the request when cookie tampering is identified.\nNote: We recommend enabling Secure and HttpOnly attributes along with cookie tampering protection.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.random": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.custom_ip_allowed_list": {
"type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.ip_allowed_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_ip_allowed_list": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.policies": {
"type": "object",
"description": "List of rate limiter policies to be applied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.rate_limiter": {
"type": "object",
"description": "A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ring_hash": {
"type": "object",
"description": "List of hash policy rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ring_hash.hash_policy": {
"type": "array",
"description": "Specifies a list of hash policies to use for ring hash load balancing. Each\nhash policy is evaluated individually and the combined result is used to\nroute the request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "Routes allow users to define match condition on a path and/or HTTP method to either forward matching traffic\nto origin pool or redirect matching traffic to a different URL or respond directly to matching traffic.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_disclosure_rules": {
"type": "object",
"description": "Sensitive Data Exposure Rules allows specifying rules to mask sensitive data fields in API responses.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_disclosure_rules.sensitive_data_types_in_response": {
"type": "array",
"description": "Sensitive Data Exposure Rules allows specifying rules to mask sensitive data fields in API responses.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "object",
"description": "Settings for data type policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy.sensitive_data_policy_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app": {
"type": "object",
"description": "Specific settings for Machine learning analysis on this HTTP LB, independently from other LBs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.disable_discovery": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.disable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.enable_discovery": {
"type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.enable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation": {
"type": "object",
"description": "\"Slow and low\" attacks tie up server resources, leaving none available for servicing\nrequests from actual users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.disable_request_timeout": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_headers_timeout": {
"type": "integer",
"description": "The amount of time the client has to send only the headers on the request stream before\nthe stream is cancelled. The default value is 10000 milliseconds. This setting\nprovides protection against Slowloris attacks.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_timeout": {
"type": "integer",
"description": "Exclusive with [disable_request_timeout]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 300000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.source_ip_stickiness": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.system_default_timeouts": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.trusted_clients": {
"type": "array",
"description": "Define rules to skip processing of one or more features such as WAF, Bot Defense etc. For clients.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_id_client_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_inline_rules": {
"type": "object",
"description": "A list of WAF exclusion rules that will be applied inline.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
],
"spec.api_definition_choice": [
      "api_specification",
      "disable_api_definition"
      ],
"spec.api_discovery_choice": [
      "disable_api_discovery",
      "enable_api_discovery"
      ],
"spec.api_testing_choice": [
      "api_testing",
      "disable_api_testing"
      ],
"spec.bot_defense_choice": [
"bot_defense",
"bot_defense_advanced",
"disable_bot_defense"
],
"spec.cache_options": [
"caching_policy",
"disable_caching"
],
"spec.challenge_type": [
"captcha_challenge",
"enable_challenge",
"js_challenge",
"no_challenge",
"policy_based_challenge"
],
"spec.client_side_defense_choice": [
"client_side_defense",
"disable_client_side_defense"
],
"spec.hash_policy_choice": [
"cookie_stickiness",
"least_active",
"random",
"ring_hash",
"round_robin",
"source_ip_stickiness"
],
"spec.ip_reputation_choice": [
"disable_ip_reputation",
"enable_ip_reputation"
],
"spec.l7_ddos_auto_mitigation_action": [
"l7_ddos_action_block",
"l7_ddos_action_default",
"l7_ddos_action_js_challenge"
],
"spec.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"spec.malicious_user_detection_choice": [
"disable_malicious_user_detection",
"enable_malicious_user_detection"
],
"spec.malware_protection": [
"disable_malware_protection",
"malware_protection_settings"
],
"spec.ml_config_choice": [
"multi_lb_app",
"single_lb_app"
],
"spec.origin_pool_choice": [
"default_pool",
"default_pool_list"
],
"spec.rate_limit_choice": [
"api_rate_limit",
      "disable_rate_limit",
"rate_limit"
],
"spec.sensitive_data_policy_choice": [
"default_sensitive_data_policy",
"sensitive_data_policy"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
],
"spec.slow_ddos_mitigation_choice": [
"slow_ddos_mitigation",
"system_default_timeouts"
],
"spec.threat_mesh_choice": [
"disable_threat_mesh",
"enable_threat_mesh"
],
"spec.trust_client_ip_headers_choice": [
"disable_trust_client_ip_headers",
"enable_trust_client_ip_headers"
],
"spec.user_id_choice": [
"user_id_client_ip",
"user_identification"
],
"spec.waf_choice": [
"app_firewall",
"disable_waf"
],
"spec.api_rate_limit.ip_allowed_list_choice": [
      "bypass_rate_limiting_rules",
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.api_specification.validation_target_choice": [
      "validation_all_spec_endpoints",
"validation_custom_list",
"validation_disabled"
],
"spec.api_specification.validation_all_spec_endpoints.oversized_body_choice": [],
      "spec.api_specification.validation_custom_list.oversized_body_choice": [],
      "spec.api_testing.frequency_choice": [
      "every_day",
"every_month",
"every_week"
],
"spec.bot_defense.cors_support_choice": [
"disable_cors_support",
"enable_cors_support"
],
"spec.bot_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.bot_defense.policy.mobile_sdk_choice": [
"disable_mobile_sdk",
"mobile_sdk_config"
],
"spec.bot_defense_advanced.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.bot_defense_advanced.mobile_sdk_choice": [
"disable_mobile_sdk",
"mobile_sdk_config"
],
"spec.caching_policy.default_cache_action.cache_actions": [
"cache_disabled",
"cache_ttl_default",
"cache_ttl_override"
],
"spec.client_side_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.cookie_stickiness.httponly": [
"add_httponly",
"ignore_httponly"
],
"spec.cookie_stickiness.samesite": [
"ignore_samesite",
"samesite_lax",
"samesite_none",
"samesite_strict"
],
"spec.cookie_stickiness.secure": [
"add_secure",
"ignore_secure"
],
"spec.csrf_policy.allowed_domains": [
"all_load_balancer_domains",
"custom_domain_list",
"disabled"
],
"spec.default_pool.health_check_port_choice": [
"health_check_port",
"same_as_endpoint_port"
],
"spec.default_pool.port_choice": [
"automatic_port",
"lb_port",
"port"
],
"spec.default_pool.tls_choice": [
"no_tls",
"use_tls"
],
"spec.default_pool.advanced_options.circuit_breaker_choice": [
"circuit_breaker",
"default_circuit_breaker",
"disable_circuit_breaker"
],
"spec.default_pool.advanced_options.http_protocol_type": [
"auto_http_config",
"http1_config",
"http2_options"
],
"spec.default_pool.advanced_options.lb_source_ip_persistence_choice": [
"disable_lb_source_ip_persistence",
"enable_lb_source_ip_persistence"
],
"spec.default_pool.advanced_options.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.default_pool.advanced_options.outlier_detection_choice": [
"disable_outlier_detection",
"outlier_detection"
],
"spec.default_pool.advanced_options.panic_threshold_type": [
"no_panic_threshold",
"panic_threshold"
],
"spec.default_pool.advanced_options.proxy_protocol_choice": [
"disable_proxy_protocol",
"proxy_protocol_v1",
"proxy_protocol_v2"
],
"spec.default_pool.advanced_options.subset_choice": [
"disable_subsets",
"enable_subsets"
],
"spec.default_pool.upstream_conn_pool_reuse_type.map_downstream_to_upstream_conn_pool_type": [
"disable_conn_pool_reuse",
"enable_conn_pool_reuse"
],
"spec.default_pool.use_tls.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.default_pool.use_tls.mtls_choice": [
"no_mtls",
"use_mtls",
"use_mtls_obj"
],
"spec.default_pool.use_tls.server_validation_choice": [
"skip_server_verification",
"use_server_verification",
"volterra_trusted_ca"
],
"spec.default_pool.use_tls.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.enable_api_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.enable_api_discovery.learn_from_redirect_traffic": [
      "disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.enable_api_discovery.api_crawler.api_crawler": [
      "api_crawler_config",
      "disable_api_crawler"
      ],
"spec.enable_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.enable_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.enable_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.http.port_choice": [
"port",
"port_ranges"
],
"spec.https.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.https.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.https.port_choice": [
"port",
"port_ranges"
],
"spec.https.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.https.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.https.coalescing_options.coalescing_choice": [
"default_coalescing",
"strict_coalescing"
],
"spec.https.http_protocol_options.http_protocol_choice": [
"http_protocol_enable_v1_only",
"http_protocol_enable_v1_v2",
"http_protocol_enable_v2_only"
],
"spec.https.tls_cert_params.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https.tls_parameters.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_auto_cert.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.https_auto_cert.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_auto_cert.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.https_auto_cert.port_choice": [
"port",
"port_ranges"
],
"spec.https_auto_cert.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.https_auto_cert.coalescing_options.coalescing_choice": [
"default_coalescing",
"strict_coalescing"
],
"spec.https_auto_cert.http_protocol_options.http_protocol_choice": [
"http_protocol_enable_v1_only",
"http_protocol_enable_v1_v2",
"http_protocol_enable_v2_only"
],
"spec.https_auto_cert.tls_config.choice": [
"custom_security",
"default_security",
"low_security",
"medium_security"
],
"spec.https_auto_cert.use_mtls.crl_choice": [
"crl",
"no_crl"
],
"spec.https_auto_cert.use_mtls.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
],
"spec.https_auto_cert.use_mtls.xfcc_header": [
"xfcc_disabled",
"xfcc_options"
],
"spec.jwt_validation.jwks_configuration": [
"authorization_server",
      "jwks_config"
],
"spec.jwt_validation.action.action_choice": [
"block",
"report"
],
"spec.jwt_validation.reserved_claims.audience_validation": [
"audience",
"audience_disable"
],
"spec.jwt_validation.reserved_claims.issuer_validation": [
"issuer",
"issuer_disable"
],
"spec.jwt_validation.reserved_claims.validate_period": [
"validate_period_disable",
"validate_period_enable"
],
"spec.jwt_validation.target.target": [
"all_endpoint",
"api_groups",
      "base_paths"
],
"spec.jwt_validation.token_location.token_location": [
      "bearer_token"
      ],
"spec.l7_ddos_protection.clientside_action_choice": [
"clientside_action_captcha_challenge",
"clientside_action_js_challenge",
"clientside_action_none"
],
"spec.l7_ddos_protection.ddos_policy_choice": [
"ddos_policy_custom",
"ddos_policy_none"
],
"spec.l7_ddos_protection.mitigation_action_choice": [
"mitigation_block",
"mitigation_captcha_challenge",
"mitigation_js_challenge"
],
"spec.l7_ddos_protection.rps_threshold_choice": [
"default_rps_threshold",
"rps_threshold"
],
"spec.more_option.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.more_option.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.more_option.strict_sni_host_header_check_choice": [],
"spec.policy_based_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.policy_based_challenge.challenge_choice": [
"always_enable_captcha_challenge",
"always_enable_js_challenge",
"no_challenge"
],
"spec.policy_based_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.policy_based_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.policy_based_challenge.temporary_blocking_parameters_choice": [
"default_temporary_blocking_parameters",
"temporary_user_blocking"
],
"spec.rate_limit.ip_allowed_list_choice": [
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.rate_limit.policy_choice": [
"no_policies",
"policies"
],
"spec.rate_limit.rate_limiter.action_choice": [
"action_block",
"disabled"
],
"spec.rate_limit.rate_limiter.algorithm": [
"leaky_bucket",
"token_bucket"
      ],
"spec.single_lb_app.api_discovery_choice": [
      "disable_discovery",
"enable_discovery"
],
"spec.single_lb_app.malicious_user_detection_choice": [
"disable_malicious_user_detection",
"enable_malicious_user_detection"
],
"spec.single_lb_app.enable_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.single_lb_app.enable_discovery.learn_from_redirect_traffic": [
"disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.slow_ddos_mitigation.request_timeout_choice": [
"disable_request_timeout",
"request_timeout"
],
"spec.waf_exclusion.waf_exclusion_choice": [
"waf_exclusion_inline_rules",
"waf_exclusion_policy"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_http_loadbalancer",
"description": "Replace HTTP Load Balancer.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a http_loadbalancer",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewshttp_loadbalancerReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.domains"
],
"mutually_exclusive_groups": [
{
"name": "lb_type",
"fields": [
"spec.http",
"spec.https",
"spec.https_auto_cert"
],
"reason": "Choose exactly one load balancer type"
},
{
"name": "advertising",
"fields": [
"spec.advertise_on_public_default_vip",
"spec.advertise_on_public",
"spec.advertise_custom",
"spec.do_not_advertise"
],
"reason": "Choose exactly one advertising method"
},
{
"name": "waf",
"fields": [
"spec.app_firewall",
"spec.disable_waf"
],
"reason": "WAF enabled or disabled"
},
{
"name": "bot_defense",
"fields": [
"spec.bot_defense",
"spec.bot_defense_advanced",
"spec.disable_bot_defense"
],
"reason": "Bot defense enabled or disabled"
},
{
"name": "rate_limit",
"fields": [
"spec.api_rate_limit",
      "spec.disable_rate_limit",
"spec.rate_limit"
],
"reason": "Rate limiting enabled or disabled"
},
{
"name": "api_discovery",
      "fields": [
"spec.disable_api_discovery",
      "spec.enable_api_discovery"
      ],
"reason": "API discovery enabled or disabled"
      },
{
"name": "api_testing",
      "fields": [
"spec.api_testing",
      "spec.disable_api_testing"
      ],
"reason": "API testing enabled or disabled"
      },
{
"name": "api_definition",
      "fields": [
"spec.api_specification",
      "spec.disable_api_definition"
      ],
"reason": "API definition enabled or disabled"
      },
{
"name": "malware_protection",
"fields": [
"spec.disable_malware_protection",
"spec.malware_protection_settings"
],
"reason": "Malware protection enabled or disabled"
},
{
"name": "client_side_defense",
"fields": [
"spec.client_side_defense",
"spec.disable_client_side_defense"
],
"reason": "Client-side defense enabled or disabled"
},
{
"name": "ip_reputation",
"fields": [
"spec.disable_ip_reputation",
"spec.enable_ip_reputation"
],
"reason": "IP reputation enabled or disabled"
},
{
"name": "threat_mesh",
"fields": [
"spec.disable_threat_mesh",
"spec.enable_threat_mesh"
],
"reason": "Threat mesh enabled or disabled"
},
{
"name": "malicious_user_detection",
"fields": [
"spec.disable_malicious_user_detection",
"spec.enable_malicious_user_detection"
],
"reason": "Malicious user detection enabled or disabled"
},
{
"name": "tls_config",
"fields": [
"spec.https_auto_cert.tls_config.default_security",
"spec.https_auto_cert.tls_config.medium_security",
"spec.https_auto_cert.tls_config.low_security",
"spec.https_auto_cert.tls_config.custom_security"
],
"reason": "Choose exactly one TLS security level"
},
{
"name": "mtls",
"fields": [
"spec.https_auto_cert.no_mtls",
"spec.https_auto_cert.use_mtls"
],
"reason": "Mutual TLS enabled or disabled"
},
{
"name": "server_name_header",
"fields": [
"spec.https_auto_cert.append_server_name",
"spec.https_auto_cert.default_header",
"spec.https_auto_cert.pass_through",
"spec.https_auto_cert.server_name"
],
"reason": "Choose exactly one server name header handling"
},
{
"name": "path_normalize",
"fields": [
"spec.https_auto_cert.enable_path_normalize",
"spec.https_auto_cert.disable_path_normalize"
],
"reason": "Path normalization enabled or disabled"
},
{
"name": "loadbalancer_choice",
"fields": [
"spec.https_auto_cert.non_default_loadbalancer",
"spec.https_auto_cert.default_loadbalancer"
],
"reason": "Choose default or non-default load balancer"
},
{
"name": "http_protocol",
"fields": [
"spec.https_auto_cert.http_protocol_options.http_protocol_enable_v1_only",
"spec.https_auto_cert.http_protocol_options.http_protocol_enable_v1_v2",
"spec.https_auto_cert.http_protocol_options.http_protocol_enable_v2_only"
],
"reason": "Choose exactly one HTTP protocol version configuration"
},
{
"name": "coalescing",
"fields": [
"spec.https_auto_cert.coalescing_options.default_coalescing",
"spec.https_auto_cert.coalescing_options.strict_coalescing"
],
"reason": "Choose exactly one connection coalescing option"
},
{
"name": "ddos_mitigation",
"fields": [
"spec.l7_ddos_protection.mitigation_block",
"spec.l7_ddos_protection.mitigation_captcha_challenge",
"spec.l7_ddos_protection.mitigation_js_challenge"
],
"reason": "Choose exactly one DDoS mitigation action"
},
{
"name": "ddos_rps_threshold",
"fields": [
"spec.l7_ddos_protection.default_rps_threshold",
"spec.l7_ddos_protection.rps_threshold"
],
"reason": "Choose default or custom RPS threshold"
},
{
"name": "ddos_clientside_action",
"fields": [
"spec.l7_ddos_protection.clientside_action_captcha_challenge",
"spec.l7_ddos_protection.clientside_action_js_challenge",
"spec.l7_ddos_protection.clientside_action_none"
],
"reason": "Choose exactly one client-side DDoS action"
},
{
"name": "ddos_policy",
"fields": [
"spec.l7_ddos_protection.ddos_policy_custom",
"spec.l7_ddos_protection.ddos_policy_none"
],
"reason": "DDoS policy reference or none"
},
{
"name": "challenge",
"fields": [
"spec.no_challenge",
"spec.js_challenge",
"spec.captcha_challenge",
"spec.enable_challenge",
"spec.policy_based_challenge"
],
"reason": "Choose exactly one challenge type"
},
{
"name": "user_identification",
"fields": [
"spec.user_id_client_ip",
"spec.user_identification"
],
"reason": "Choose user identification method"
},
{
"name": "client_ip_headers",
"fields": [
"spec.disable_trust_client_ip_headers",
"spec.enable_trust_client_ip_headers"
],
"reason": "Trust client IP headers or not"
},
{
"name": "service_policies_source",
"fields": [
"spec.service_policies_from_namespace",
"spec.active_service_policies",
"spec.no_service_policies"
],
"reason": "Service policies from namespace, active list, or none"
},
{
"name": "sensitive_data_policy",
"fields": [
"spec.default_sensitive_data_policy",
"spec.sensitive_data_policy"
],
"reason": "Use default or custom sensitive data policy"
},
{
"name": "load_balancing_algorithm",
"fields": [
"spec.least_active",
"spec.random",
"spec.ring_hash",
"spec.round_robin"
],
"reason": "Choose exactly one load balancing algorithm"
}
],
"example_yaml": "apiVersion: v1\nkind: http_loadbalancer\nmetadata:\n  name: example-app\n  namespace: default\nspec:\n  domains:\n    - example.com\n  https_auto_cert: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-app\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"domains\": [\"ar-test.example.com\"],\n    \"advertise_on_public_default_vip\": {},\n    \"http\": {\"port\": 80}\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-app",
"namespace": "default"
},
"spec": {
"domains": [
"ar-test.example.com"
],
"advertise_on_public_default_vip": {},
"http": {
"port": 80
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.domains"
],
"description": "HTTP/HTTPS load balancer for distributing traffic across origin pools"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the HTTP load balancer specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.add_location": {
"type": "boolean",
"description": "X-example: true\nAppends header x-F5 Distributed Cloud-location = <RE-site-name> in responses. This configuration\nis ignored on CE sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public.public_ip": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_protection_rules": {
      "type": "object",
"description": "API Protection Rules.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_protection_rules.api_endpoint_rules": {
      "type": "array",
"description": "This category defines specific rules per API endpoints.\nIf request matches any of these rules, skipping second category rules.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_protection_rules.api_groups_rules": {
      "type": "array",
"description": "This category includes rules per API group or Server URL.\nFor API groups, refer to API Definition which includes API groups derived from uploaded swaggers.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.api_endpoint_rules": {
      "type": "array",
"description": "Ordered endpoint-specific rate-limit rules. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.bypass_rate_limiting_rules": {
      "type": "object",
"description": "This category defines rules per URL or API group. If request matches any of these rules, skip Rate Limiting.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.custom_ip_allowed_list": {
      "type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.ip_allowed_list": {
      "type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.no_ip_allowed_list": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_rate_limit.server_url_rules": {
      "type": "array",
"description": "Ordered domain or base-path rules for path-scoped rate limiting. Each rule must choose exactly one rate_limiter_choice: inline_rate_limiter or ref_rate_limiter.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification": {
      "type": "object",
"description": "Settings for API specification (API definition, OpenAPI validation, etc.)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_all_spec_endpoints": {
      "type": "object",
"description": "Settings for API Inventory validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_custom_list": {
      "type": "object",
"description": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.\nAny other API-endpoint not listed will act according to \"Fall Through Mode\".",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.custom_header_value": {
      "type": "string",
"description": "Add x-F5-API-testing-identifier header value to prevent security flags on API testing traffic.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.domains": {
      "type": "array",
"description": "Add and configure testing domains and credentials.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.api_testing.every_day": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.every_month": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_testing.every_week": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.app_firewall.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_clients": {
"type": "array",
"description": "Define rules to block IP Prefixes or AS numbers.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.disable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.enable_cors_support": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Bot Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense.regional_endpoint": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- AUTO: AUTO\n\nAutomatic selection based on client IP address\n- US: US\n\nUS region\n- EU: EU\n\nEuropean Union region\n- ASIA: ASIA\n\nAsia region.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AUTO"
},
"spec.bot_defense.timeout": {
"type": "integer",
"description": "The timeout for the inference check, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 60000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced": {
"type": "object",
"description": "Bot Defense Advanced.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.disable_js_insert": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.disable_mobile_sdk": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.js_insert_all_pages": {
"type": "object",
"description": "Insert Bot Defense JavaScript in all pages.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.js_insert_all_pages_except": {
"type": "object",
"description": "Insert Bot Defense JavaScript in all pages with the exceptions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.js_insertion_rules": {
"type": "object",
"description": "This defines custom JavaScript insertion rules for Bot Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.mobile": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.mobile_sdk_config": {
"type": "object",
"description": "Mobile Request Identifier Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_defense_advanced.web": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.caching_policy": {
"type": "object",
"description": "Caching Policies for the CDN.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.caching_policy.custom_cache_rule": {
"type": "object",
"description": "Caching policies for CDN.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.caching_policy.default_cache_action": {
"type": "object",
"description": "This defines a Default Cache Action.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.captcha_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_side_defense.policy": {
"type": "object",
"description": "This defines various configuration OPTIONS for Client-Side Defense policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness": {
"type": "object",
"description": "Two types of cookie affinity:\n\n1. Passive. Takes a cookie that's present in the cookies header and\nhashes on its value.\n\n2. Generated. Generates and sets a cookie with an expiration (TTL)\non the first request from the client in its response to the client,\nbased on the endpoint the request gets sent to. The client then\npresents this on the next and all subsequent requests. The hash of\nthis is sufficient to ensure these requests GET sent to the same\nendpoint. The cookie is generated by hashing the source and\ndestination ports and addresses so that multiple independent HTTP2\nstreams on the same connection will independently receive the same\ncookie, even if they arrive simultaneously.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.add_httponly": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.add_secure": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ignore_httponly": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ignore_samesite": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ignore_secure": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.name": {
"type": "string",
"description": "The name of the cookie that will be used to obtain the hash key. If the\ncookie is not present and TTL below is not set, no hash will be\nproduced.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.path": {
"type": "string",
"description": "The name of the path for the cookie. If no path is specified here, no path\nwill be set for the cookie.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.samesite_lax": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.samesite_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.samesite_strict": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cookie_stickiness.ttl": {
"type": "integer",
"description": "If specified, a cookie with the TTL will be generated if the cookie is\nnot present. If the TTL is present and zero, the generated cookie will\nbe a session cookie. TTL value is in milliseconds.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy": {
"type": "object",
"description": "Cross-Origin Resource Sharing requests configuration specified at Virtual-host or\nRoute level. Route level configuration takes precedence.\n\nAn example of an Cross origin HTTP request\nGET /resources/public-data/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nReferrer: http://foo.example/examples/access-control/simplexsinvocation.html\nOrigin: http://foo.example\n\nHTTP/1.1 200 OK\nDate: Mon, 01 Dec 2008 00:23:53 GMT\nServer: Apache/2.0.61\nAccess-Control-Allow-Origin: *\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive\nTransfer-Encoding: chunked\nContent-Type: application/XML\n\nAn example for cross origin HTTP OPTIONS request with Access-Control-Request-* header\n\nOPTIONS /resources/POST-here/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nOrigin: http://foo.example\nAccess-Control-Request-Method: POST\nAccess-Control-Request-Headers: X-PINGOTHER, Content-Type\n\nHTTP/1.1 204 No Content\nDate: Mon, 01 Dec 2008 01:15:39 GMT\nServer: Apache/2.0.61 (Unix)\nAccess-Control-Allow-Origin: http://foo.example\nAccess-Control-Allow-Methods: POST, GET, OPTIONS\nAccess-Control-Allow-Headers: X-PINGOTHER, Content-Type\nAccess-Control-Max-Age: 86400\nVary: Accept-Encoding, Origin\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_credentials": {
      "type": "boolean",
"description": "Specifies whether the resource allows credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_headers": {
"type": "string",
"description": "Specifies the content for the access-control-allow-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_methods": {
"type": "string",
"description": "Specifies the content for the access-control-allow-methods header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin": {
"type": "array",
"description": "Specifies the origins that will be allowed to do CORS requests.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin_regex": {
"type": "array",
"description": "Specifies regex patterns that match allowed origins.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.disabled": {
"type": "boolean",
"description": "Disable the CorsPolicy for a particular route. This is useful when\nvirtual-host has CorsPolicy, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.expose_headers": {
"type": "string",
"description": "Specifies the content for the access-control-expose-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.maximum_age": {
"type": "integer",
"description": "Specifies the content for the access-control-max-age header in seconds.\nThis indicates the maximum number of seconds the results can be cached\nA value of -1 will disable caching.\nMaximum permitted value is 86400 seconds (24 hours)",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy": {
"type": "object",
"description": "To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host.\n\n1. The origin that caused the user agent to issue the request (source origin).\n2. The origin that the request is going to (target origin).\nWhen the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid.\nBecause CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.all_load_balancer_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.custom_domain_list": {
"type": "object",
"description": "List of domain names used for Host header matching.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.data_guard_rules": {
"type": "array",
"description": "Data Guard prevents responses from exposing sensitive information by masking the data.\nThe system masks credit card numbers and social security numbers leaked from the application from within the HTTP response with a string of asterisks (*).\nNote: App Firewall should be enabled, to use Data Guard feature.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ddos_mitigation_rules": {
"type": "array",
"description": "Define manual mitigation rules to block L7 DDoS attacks.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool": {
"type": "object",
"description": "Shape of the origin pool specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.advanced_options": {
"type": "object",
"description": "Configure Advanced OPTIONS for origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.automatic_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.endpoint_selection": {
"type": "string",
"description": "Policy for selection of endpoints from local site/remote site/both\n\nConsider both remote and local endpoints for load balancing\nLOCAL_ONLY: Consider only local endpoints for load balancing\nEnable this policy to load balance ONLY among locally discovered endpoints\nPrefer the local endpoints for load balancing. If local endpoints are not present\nremote endpoints will be considered.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISTRIBUTED"
},
"spec.default_pool.health_check_port": {
"type": "integer",
"description": "Exclusive with [same_as_endpoint_port]\nPort used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "networking",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "networking",
"note": "Asymmetry: port enforces [1,65535], health_check_port allows 0",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.healthcheck": {
"type": "array",
"description": "Reference to healthcheck configuration objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.lb_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.loadbalancer_algorithm": {
"type": "string",
"description": "Different load balancing algorithms supported\nWhen a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm\nto determine which host is selected.\n\n- ROUND_ROBIN: ROUND_ROBIN\n\nPolicy in which each healthy/available upstream endpoint is selected in round robin order.\n- LEAST_REQUEST: LEAST_REQUEST\n\nPolicy in which loadbalancer picks the upstream endpoint which has the fewest active requests\n- RING_HASH: RING_HASH\n\nPolicy implements consistent hashing to upstream endpoints using ring hash of endpoint names\nHash of the incoming request is calculated using request hash policy.\nThe ring/modulo hash load balancer implements consistent hashing to upstream hosts.\nThe algorithm is based on mapping all hosts onto a circle such that the addition or\nremoval of a host from the host set changes only affect 1/N requests. This technique\nis also commonly known as “ketama” hashing. A consistent hashing load balancer is only\neffective when protocol routing is used that specifies a value to hash on. The minimum\nring size governs the replication factor for each host in the ring. For example, if the\nminimum ring size is 1024 and there are 16 hosts, each host will be replicated 64 times.\n- RANDOM: RANDOM\n\nPolicy in which each available upstream endpoint is selected in random order.\nThe random load balancer selects a random healthy host. The random load balancer generally\nperforms better than round robin if no health checking policy is configured. Random selection\navoids bias towards the host in the set that comes after a failed host.\n- LB_OVERRIDE: Load Balancer Override\n\nHash policy is taken from from the load balancer which is using this origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ROUND_ROBIN"
},
"spec.default_pool.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.origin_servers": {
"type": "array",
"description": "List of origin servers in this pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.default_pool.port": {
"type": "integer",
"description": "Exclusive with [automatic_port lb_port]\nEndpoint service is available on this port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.same_as_endpoint_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.upstream_conn_pool_reuse_type": {
"type": "object",
"description": "Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.use_tls": {
"type": "object",
"description": "Upstream TLS Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool.view_internal": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool_list": {
"type": "object",
"description": "List of Origin Pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_pool_list.pools": {
"type": "array",
"description": "List of Origin Pools.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_route_pools": {
"type": "array",
"description": "Origin Pools used when no route is specified (default route)",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sensitive_data_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_definition": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_testing": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_bot_defense": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_caching": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_client_side_defense": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ip_reputation": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_malware_protection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_rate_limit": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_trust_client_ip_headers": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of Domains (host/authority header) that will be matched to load balancer.\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.\n\nDomains are also used for SNI matching if the Loadbalancer type is HTTPS.\nDomains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_api_discovery": {
      "type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_crawler": {
      "type": "object",
"description": "API Crawler message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_discovery_from_code_scan": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.custom_api_auth_discovery": {
      "type": "object",
"description": "API Discovery Advanced settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.default_api_auth_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.disable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.enable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge": {
"type": "object",
"description": "Configure auto mitigation i.e risk based challenges for malicious users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation": {
"type": "object",
"description": "List of IP threat categories.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ip_reputation.ip_threat_categories": {
"type": "array",
"description": "If the source IP matches on atleast one of the enabled IP threat categories, the request will be denied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_threat_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_trust_client_ip_headers": {
"type": "object",
"description": "List of Client IP Headers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_trust_client_ip_headers.client_ip_headers": {
"type": "array",
"description": "Define the list of one or more Client IP Headers. Headers will be used in order from top to bottom, meaning\nif the first header is not present in the request, the system will proceed to check for the second header,\nand so on, until one of the listed headers is found. If none of the defined headers exist, or the value\nis not an IP address, then the system will use the source IP of the packet. If multiple defined headers with\ndifferent names are present in the request, the value of the first header name in the configuration will be used.\nIf multiple defined headers with the same name are present in the request, values of all those headers will be combined.\nThe system will read the right-most IP address from header, if there are multiple IP addresses in the header value.\nFor X-Forwarded-For header, the system will read the IP address(rightmost - 1), as the client IP.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 5,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.graphql_rules": {
"type": "array",
"description": "GraphQL is a query language and server-side runtime for APIs which provides a complete and understandable\ndescription of the data in API. GraphQL gives clients the power to ask for exactly what they need, makes it\neasier to evolve APIs over time, and enables powerful developer tools. Policy configuration to analyze GraphQL\nqueries and prevent GraphQL tailored attacks.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http": {
"type": "object",
"description": "Choice for selecting HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nAs a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature\nor a DNS CNAME record should be created in your DNS provider's portal.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTP port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.append_server_name": {
"type": "string",
"description": "Exclusive with [default_header pass_through server_name]\nDefine the header value for the header name “server”.\nIf header value is already present, it is not overwritten and passed as-is.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.coalescing_options": {
"type": "object",
"description": "TLS connection coalescing configuration (not compatible with mTLS)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.connection_idle_timeout": {
"type": "integer",
"description": "The idle timeout for downstream connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 2 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.default_header": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.http_protocol_options": {
"type": "object",
"description": "HTTP protocol configuration OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.non_default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.pass_through": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTPS port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.server_name": {
"type": "string",
"description": "Exclusive with [append_server_name default_header pass_through]\nDefine the header value for the header name “server”.\nThis will overwrite existing values, if any, for the server header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.tls_cert_params": {
"type": "object",
"description": "Select TLS Parameters and Certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https.tls_parameters": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert": {
"type": "object",
"description": "Choice for selecting HTTP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.add_hsts": {
"type": "boolean",
"description": "Add HTTP Strict-Transport-Security response header.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.append_server_name": {
"type": "string",
"description": "Exclusive with [default_header pass_through server_name]\nDefine the header value for the header name “server”.\nIf header value is already present, it is not overwritten and passed as-is.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.coalescing_options": {
"type": "object",
"description": "TLS connection coalescing configuration (not compatible with mTLS)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.connection_idle_timeout": {
"type": "integer",
"description": "The idle timeout for downstream connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 2 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.default_header": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.http_protocol_options": {
"type": "object",
"description": "HTTP protocol configuration OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.http_redirect": {
"type": "boolean",
"description": "Redirect HTTP traffic to HTTPS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.no_mtls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.non_default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.pass_through": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nHTTPS port to Listen.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.port_ranges": {
"type": "string",
"description": "Exclusive with [port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.server_name": {
"type": "string",
"description": "Exclusive with [append_server_name default_header pass_through]\nDefine the header value for the header name “server”.\nThis will overwrite existing values, if any, for the server header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_auto_cert.use_mtls": {
"type": "object",
"description": "Validation context for downstream client TLS connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.jwt_validation": {
"type": "object",
"description": "JWT Validation stops JWT replay attacks and JWT tampering by cryptographically verifying incoming\nJWTs before they are passed to your API origin. JWT Validation will also stop requests with expired\ntokens or tokens that are not yet valid.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.action": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.authorization_server": {
      "type": "object",
"description": "Reference to Authorization Server object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.jwks_config": {
"type": "object",
"description": "The JSON Web Key Set (JWKS) is a set of keys used to verify JSON Web Token (JWT) issued by the Authorization Server. See RFC 7517 for more details.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.mandatory_claims": {
"type": "object",
"description": "Configurable Validation of mandatory Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.reserved_claims": {
"type": "object",
"description": "Configurable Validation of reserved Claims.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.target": {
"type": "object",
"description": "Define endpoints for which JWT token validation will be performed.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_validation.token_location": {
      "type": "object",
"description": "Location of JWT in HTTP request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_block": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_action_js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection": {
"type": "object",
"description": "L7 DDoS protection is critical for safeguarding web applications, APIs, and services that are exposed to the internet\nfrom sophisticated, volumetric, application-level threats. Configure actions, thresholds and policies to apply during\nL7 DDoS attack.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.clientside_action_captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.clientside_action_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.clientside_action_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.ddos_policy_custom": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.ddos_policy_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.default_rps_threshold": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.mitigation_block": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.mitigation_captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.mitigation_js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.l7_ddos_protection.rps_threshold": {
"type": "integer",
"description": "Exclusive with [default_rps_threshold]\nConfigure custom RPS threshold.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 50000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.least_active": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.malware_protection_settings": {
"type": "object",
"description": "Malware Protection protects Web Apps and APIs, from malicious file uploads by scanning files in real-time.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.malware_protection_settings.malware_protection_rules": {
"type": "array",
"description": "Configure the match criteria to trigger Malware Protection Scan.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.more_option": {
"type": "object",
"description": "This defines various OPTIONS to define a route.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.buffer_policy": {
"type": "object",
"description": "Some upstream applications are not capable of handling streamed data. This config\nenables buffering the entire request before sending to upstream application. We can\nspecify the maximum buffer size and buffer interval with this config.\n\nBuffering can be enabled and disabled at VirtualHost and Route levels\nRoute level buffer configuration takes precedence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.compression_params": {
"type": "object",
"description": "Enables loadbalancer to compress dispatched data from an upstream service upon client request.\nThe content is compressed and then sent to the client with the appropriate headers if either response and request allow.\nOnly GZIP compression is supported.\n\nBy default compression will be skipped when:\n\nA request does NOT contain accept-encoding header.\nA request includes accept-encoding header, but it does not contain “gzip” or “*”.\nA request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress.\nA request whose accept-encoding header includes “identity”.\nA response contains a content-encoding header.\nA response contains a cache-control header whose value includes “no-transform”.\nA response contains a transfer-encoding header whose value includes “gzip”.\nA response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML.\nNeither content-length nor transfer-encoding headers are present in the response.\nResponse size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked).\n\nWhen compression is applied:\n\nThe content-length is removed from response headers.\nResponse headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header.\nThe “vary: accept-encoding” header is inserted on every response.\n\nGZIP Compression Level:\n\nA value which is optimal balance between speed of compression and amount of compression is chosen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.custom_errors": {
"type": "object",
"description": "Map of integer error codes as keys and string values that can be used to provide custom\nHTTP pages for each error code.\nKey of the map can be either response code class or HTTP Error code. Response code classes\nfor key is configured as follows\n3 -- for 3xx response code class\n4 -- for 4xx response code class\n5 -- for 5xx response code class\nValue of the map is string which represents custom HTTP responses.\nSpecific response code takes preference when both response code and response code class\nmatches for a request.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.disable_default_error_pages": {
"type": "boolean",
"description": "Disable the use of default F5XC error pages.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.idle_timeout": {
"type": "integer",
"description": "The amount of time that a stream can exist without upstream or downstream activity, in milliseconds.\nThe stream is terminated with a HTTP 504 (Gateway Timeout) error code if no upstream response header has been\nreceived, otherwise the stream is reset.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 3600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.max_request_header_size": {
"type": "integer",
"description": "The maximum request header size for downstream connections, in KiB.\nA HTTP 431 (Request Header Fields Too Large) error code is sent for requests that exceed this size.\n\nIf multiple load balancers share the same advertise_policy, the highest value configured across all\nsuch load balancers is used for all the load balancers in question.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 96,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\nSets the maximum number of requests a downstream client can send\nover a single connection to Envoy.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_cookies_to_add": {
"type": "array",
"description": "Cookies are key-value pairs to be added to HTTP request being routed towards upstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_cookies_to_remove": {
"type": "array",
"description": "List of keys of Cookies to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP request being routed towards upstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.request_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_cookies_to_add": {
"type": "array",
"description": "Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_cookies_to_remove": {
"type": "array",
"description": "List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP response being sent towards downstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.more_option.response_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP response being sent towards downstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.multi_lb_app": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_server_subset_rule_list": {
"type": "object",
"description": "List of Origin Pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_server_subset_rule_list.origin_server_subset_rules": {
"type": "array",
"description": "Origin Server Subset Rules allow users to define match condition on Client (IP address, ASN, Country), IP Reputation, Regional Edge names,\nRequest for subset selection of origin servers. Origin Server Subset is a sequential engine where rules are evaluated one after the other.\nIt's important to define the correct order for Origin Server Subset to GET the intended result, rules are evaluated from top to bottom in the list.\nWhen an Origin server subset rule is matched, then this selection rule takes effect and no more rules are evaluated.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge": {
"type": "object",
"description": "Specifies the settings for policy rule based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_captcha_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.always_enable_js_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.captcha_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_captcha_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_js_challenge_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_mitigation_settings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.default_temporary_blocking_parameters": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.js_challenge_parameters": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.malicious_user_mitigation": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.rule_list": {
"type": "object",
"description": "List of challenge rules to be used in policy based challenge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_based_challenge.temporary_user_blocking": {
"type": "object",
"description": "Specifies configuration for temporary user blocking resulting from user behavior analysis.\n\nWhen Malicious User Mitigation is enabled from service policy rules, users' accessing the application will be analyzed for\nmalicious activity and the configured mitigation actions will be taken on identified malicious users.\nThese mitigation actions include setting up temporary blocking on that user.\nThis configuration specifies settings on how that blocking should be done by the loadbalancer.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protected_cookies": {
"type": "array",
"description": "Allows setting attributes (SameSite, Secure, and HttpOnly) on cookies in responses.\nCookie Tampering Protection prevents attackers from modifying the value of session cookies.\nFor Cookie Tampering Protection, enabling a web app firewall (WAF) is a prerequisite.\nThe configured mode of WAF (monitoring or blocking) will be enforced on the request when cookie tampering is identified.\nNote: We recommend enabling Secure and HttpOnly attributes along with cookie tampering protection.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.random": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.custom_ip_allowed_list": {
"type": "object",
"description": "IP Allowed list using existing ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.ip_allowed_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_ip_allowed_list": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.no_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.policies": {
"type": "object",
"description": "List of rate limiter policies to be applied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limit.rate_limiter": {
"type": "object",
"description": "A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ring_hash": {
"type": "object",
"description": "List of hash policy rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ring_hash.hash_policy": {
"type": "array",
"description": "Specifies a list of hash policies to use for ring hash load balancing. Each\nhash policy is evaluated individually and the combined result is used to\nroute the request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "Routes allow users to define match condition on a path and/or HTTP method to either forward matching traffic\nto origin pool or redirect matching traffic to a different URL or respond directly to matching traffic.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_disclosure_rules": {
"type": "object",
"description": "Sensitive Data Exposure Rules allows specifying rules to mask sensitive data fields in API responses.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_disclosure_rules.sensitive_data_types_in_response": {
"type": "array",
"description": "Sensitive Data Exposure Rules allows specifying rules to mask sensitive data fields in API responses.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "object",
"description": "Settings for data type policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy.sensitive_data_policy_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app": {
"type": "object",
"description": "Specific settings for Machine learning analysis on this HTTP LB, independently from other LBs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.disable_discovery": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.disable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.enable_discovery": {
"type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.single_lb_app.enable_malicious_user_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation": {
"type": "object",
"description": "\"Slow and low\" attacks tie up server resources, leaving none available for servicing\nrequests from actual users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.disable_request_timeout": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_headers_timeout": {
"type": "integer",
"description": "The amount of time the client has to send only the headers on the request stream before\nthe stream is cancelled. The default value is 10000 milliseconds. This setting\nprovides protection against Slowloris attacks.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_timeout": {
"type": "integer",
"description": "Exclusive with [disable_request_timeout]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 300000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.source_ip_stickiness": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.system_default_timeouts": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.trusted_clients": {
"type": "array",
"description": "Define rules to skip processing of one or more features such as WAF, Bot Defense etc. For clients.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_id_client_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_inline_rules": {
"type": "object",
"description": "A list of WAF exclusion rules that will be applied inline.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_exclusion.waf_exclusion_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
],
"spec.api_definition_choice": [
      "api_specification",
      "disable_api_definition"
      ],
"spec.api_discovery_choice": [
      "disable_api_discovery",
      "enable_api_discovery"
      ],
"spec.api_testing_choice": [
      "api_testing",
      "disable_api_testing"
      ],
"spec.bot_defense_choice": [
"bot_defense",
"bot_defense_advanced",
"disable_bot_defense"
],
"spec.cache_options": [
"caching_policy",
"disable_caching"
],
"spec.challenge_type": [
"captcha_challenge",
"enable_challenge",
"js_challenge",
"no_challenge",
"policy_based_challenge"
],
"spec.client_side_defense_choice": [
"client_side_defense",
"disable_client_side_defense"
],
"spec.hash_policy_choice": [
"cookie_stickiness",
"least_active",
"random",
"ring_hash",
"round_robin",
"source_ip_stickiness"
],
"spec.ip_reputation_choice": [
"disable_ip_reputation",
"enable_ip_reputation"
],
"spec.l7_ddos_auto_mitigation_action": [
"l7_ddos_action_block",
"l7_ddos_action_default",
"l7_ddos_action_js_challenge"
],
"spec.loadbalancer_type": [
"http",
"https",
"https_auto_cert"
],
"spec.malicious_user_detection_choice": [
"disable_malicious_user_detection",
"enable_malicious_user_detection"
],
"spec.malware_protection": [
"disable_malware_protection",
"malware_protection_settings"
],
"spec.ml_config_choice": [
"multi_lb_app",
"single_lb_app"
],
"spec.origin_pool_choice": [
"default_pool",
"default_pool_list"
],
"spec.rate_limit_choice": [
"api_rate_limit",
      "disable_rate_limit",
"rate_limit"
],
"spec.sensitive_data_policy_choice": [
"default_sensitive_data_policy",
"sensitive_data_policy"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
],
"spec.slow_ddos_mitigation_choice": [
"slow_ddos_mitigation",
"system_default_timeouts"
],
"spec.threat_mesh_choice": [
"disable_threat_mesh",
"enable_threat_mesh"
],
"spec.trust_client_ip_headers_choice": [
"disable_trust_client_ip_headers",
"enable_trust_client_ip_headers"
],
"spec.user_id_choice": [
"user_id_client_ip",
"user_identification"
],
"spec.waf_choice": [
"app_firewall",
"disable_waf"
],
"spec.api_rate_limit.ip_allowed_list_choice": [
      "bypass_rate_limiting_rules",
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.api_specification.validation_target_choice": [
      "validation_all_spec_endpoints",
"validation_custom_list",
"validation_disabled"
],
"spec.api_specification.validation_all_spec_endpoints.oversized_body_choice": [],
      "spec.api_specification.validation_custom_list.oversized_body_choice": [],
      "spec.api_testing.frequency_choice": [
      "every_day",
"every_month",
"every_week"
],
"spec.bot_defense.cors_support_choice": [
"disable_cors_support",
"enable_cors_support"
],
"spec.bot_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.bot_defense.policy.mobile_sdk_choice": [
"disable_mobile_sdk",
"mobile_sdk_config"
],
"spec.bot_defense_advanced.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.bot_defense_advanced.mobile_sdk_choice": [
"disable_mobile_sdk",
"mobile_sdk_config"
],
"spec.caching_policy.default_cache_action.cache_actions": [
"cache_disabled",
"cache_ttl_default",
"cache_ttl_override"
],
"spec.client_side_defense.policy.java_script_choice": [
"disable_js_insert",
"js_insert_all_pages",
"js_insert_all_pages_except",
"js_insertion_rules"
],
"spec.cookie_stickiness.httponly": [
"add_httponly",
"ignore_httponly"
],
"spec.cookie_stickiness.samesite": [
"ignore_samesite",
"samesite_lax",
"samesite_none",
"samesite_strict"
],
"spec.cookie_stickiness.secure": [
"add_secure",
"ignore_secure"
],
"spec.csrf_policy.allowed_domains": [
"all_load_balancer_domains",
"custom_domain_list",
"disabled"
],
"spec.default_pool.health_check_port_choice": [
"health_check_port",
"same_as_endpoint_port"
],
"spec.default_pool.port_choice": [
"automatic_port",
"lb_port",
"port"
],
"spec.default_pool.tls_choice": [
"no_tls",
"use_tls"
],
"spec.default_pool.advanced_options.circuit_breaker_choice": [
"circuit_breaker",
"default_circuit_breaker",
"disable_circuit_breaker"
],
"spec.default_pool.advanced_options.http_protocol_type": [
"auto_http_config",
"http1_config",
"http2_options"
],
"spec.default_pool.advanced_options.lb_source_ip_persistence_choice": [
"disable_lb_source_ip_persistence",
"enable_lb_source_ip_persistence"
],
"spec.default_pool.advanced_options.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.default_pool.advanced_options.outlier_detection_choice": [
"disable_outlier_detection",
"outlier_detection"
],
"spec.default_pool.advanced_options.panic_threshold_type": [
"no_panic_threshold",
"panic_threshold"
],
"spec.default_pool.advanced_options.proxy_protocol_choice": [
"disable_proxy_protocol",
"proxy_protocol_v1",
"proxy_protocol_v2"
],
"spec.default_pool.advanced_options.subset_choice": [
"disable_subsets",
"enable_subsets"
],
"spec.default_pool.upstream_conn_pool_reuse_type.map_downstream_to_upstream_conn_pool_type": [
"disable_conn_pool_reuse",
"enable_conn_pool_reuse"
],
"spec.default_pool.use_tls.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.default_pool.use_tls.mtls_choice": [
"no_mtls",
"use_mtls",
"use_mtls_obj"
],
"spec.default_pool.use_tls.server_validation_choice": [
"skip_server_verification",
"use_server_verification",
"volterra_trusted_ca"
],
"spec.default_pool.use_tls.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.enable_api_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.enable_api_discovery.learn_from_redirect_traffic": [
      "disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.enable_api_discovery.api_crawler.api_crawler": [
      "api_crawler_config",
      "disable_api_crawler"
      ],
"spec.enable_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.enable_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.enable_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.http.port_choice": [
"port",
"port_ranges"
],
"spec.https.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.https.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.https.port_choice": [
"port",
"port_ranges"
],
"spec.https.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.https.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.https.coalescing_options.coalescing_choice": [
"default_coalescing",
"strict_coalescing"
],
"spec.https.http_protocol_options.http_protocol_choice": [
"http_protocol_enable_v1_only",
"http_protocol_enable_v1_v2",
"http_protocol_enable_v2_only"
],
"spec.https.tls_cert_params.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https.tls_parameters.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_auto_cert.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.https_auto_cert.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_auto_cert.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.https_auto_cert.port_choice": [
"port",
"port_ranges"
],
"spec.https_auto_cert.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.https_auto_cert.coalescing_options.coalescing_choice": [
"default_coalescing",
"strict_coalescing"
],
"spec.https_auto_cert.http_protocol_options.http_protocol_choice": [
"http_protocol_enable_v1_only",
"http_protocol_enable_v1_v2",
"http_protocol_enable_v2_only"
],
"spec.https_auto_cert.tls_config.choice": [
"custom_security",
"default_security",
"low_security",
"medium_security"
],
"spec.https_auto_cert.use_mtls.crl_choice": [
"crl",
"no_crl"
],
"spec.https_auto_cert.use_mtls.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
],
"spec.https_auto_cert.use_mtls.xfcc_header": [
"xfcc_disabled",
"xfcc_options"
],
"spec.jwt_validation.jwks_configuration": [
"authorization_server",
      "jwks_config"
],
"spec.jwt_validation.action.action_choice": [
"block",
"report"
],
"spec.jwt_validation.reserved_claims.audience_validation": [
"audience",
"audience_disable"
],
"spec.jwt_validation.reserved_claims.issuer_validation": [
"issuer",
"issuer_disable"
],
"spec.jwt_validation.reserved_claims.validate_period": [
"validate_period_disable",
"validate_period_enable"
],
"spec.jwt_validation.target.target": [
"all_endpoint",
"api_groups",
      "base_paths"
],
"spec.jwt_validation.token_location.token_location": [
      "bearer_token"
      ],
"spec.l7_ddos_protection.clientside_action_choice": [
"clientside_action_captcha_challenge",
"clientside_action_js_challenge",
"clientside_action_none"
],
"spec.l7_ddos_protection.ddos_policy_choice": [
"ddos_policy_custom",
"ddos_policy_none"
],
"spec.l7_ddos_protection.mitigation_action_choice": [
"mitigation_block",
"mitigation_captcha_challenge",
"mitigation_js_challenge"
],
"spec.l7_ddos_protection.rps_threshold_choice": [
"default_rps_threshold",
"rps_threshold"
],
"spec.more_option.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.more_option.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.more_option.strict_sni_host_header_check_choice": [],
"spec.policy_based_challenge.captcha_challenge_parameters_choice": [
"captcha_challenge_parameters",
"default_captcha_challenge_parameters"
],
"spec.policy_based_challenge.challenge_choice": [
"always_enable_captcha_challenge",
"always_enable_js_challenge",
"no_challenge"
],
"spec.policy_based_challenge.js_challenge_parameters_choice": [
"default_js_challenge_parameters",
"js_challenge_parameters"
],
"spec.policy_based_challenge.malicious_user_mitigation_choice": [
"default_mitigation_settings",
"malicious_user_mitigation"
],
"spec.policy_based_challenge.temporary_blocking_parameters_choice": [
"default_temporary_blocking_parameters",
"temporary_user_blocking"
],
"spec.rate_limit.ip_allowed_list_choice": [
"custom_ip_allowed_list",
"ip_allowed_list",
"no_ip_allowed_list"
],
"spec.rate_limit.policy_choice": [
"no_policies",
"policies"
],
"spec.rate_limit.rate_limiter.action_choice": [
"action_block",
"disabled"
],
"spec.rate_limit.rate_limiter.algorithm": [
"leaky_bucket",
"token_bucket"
      ],
"spec.single_lb_app.api_discovery_choice": [
      "disable_discovery",
"enable_discovery"
],
"spec.single_lb_app.malicious_user_detection_choice": [
"disable_malicious_user_detection",
"enable_malicious_user_detection"
],
"spec.single_lb_app.enable_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.single_lb_app.enable_discovery.learn_from_redirect_traffic": [
"disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.slow_ddos_mitigation.request_timeout_choice": [
"disable_request_timeout",
"request_timeout"
],
"spec.waf_exclusion.waf_exclusion_choice": [
"waf_exclusion_inline_rules",
"waf_exclusion_policy"
]
}
},
{
"name": "list_http_loadbalancers",
"description": "List Configure HTTP Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_http_loadbalancer",
"description": "DELETE Configure HTTP Load Balancer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a http_loadbalancer",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for http_loadbalancerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for http_loadbalancerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
}
},
{
"name": "get_http_loadbalancer",
"description": "GET HTTP Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ike-phase1-profiles": {
"name": "ike-phase1-profiles",
"displayName": "Ike Phase1 Profiles",
"operations": [
{
"name": "create_ike_phase1_profile",
"description": "Create IKE Phase1 Profile.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/ike_phase1_profiles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of ike_phase1_profile",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.ike_phase1_profile.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/ike_phase1_profileCreateSpecType"
}
],
"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 ike_phase1_profileCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike_phase1_profileCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike_phase1_profileCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase1 profile specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication_algos": {
      "type": "array",
"description": "Choose one or more Authentication Algorithm. Use None option when using the aes-gcm or aes-ccm encryption algorithms.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dh_group": {
"type": "array",
"description": "Choose the acceptable Diffie Hellman (DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.encryption_algos": {
"type": "array",
"description": "Choose one or more encryption algorithms.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.prf": {
"type": "array",
"description": "Select PseudoRandomFunction for IKE SA.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days": {
      "type": "object",
"description": "Set Duration in days.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.ike_reauth_timeout": [
      "reauth_disabled",
      "reauth_timeout_days",
      "reauth_timeout_hours"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_ike_phase1_profile",
"description": "Replace IKE Phase1 Profile configuration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/ike_phase1_profiles/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a ike_phase1_profile",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.ike_phase1_profile.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/ike_phase1_profileReplaceSpecType"
}
],
"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 ike_phase1_profileReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike_phase1_profileReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike_phase1_profileReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase1 profile configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication_algos": {
      "type": "array",
"description": "Choose one or more Authentication Algorithm. Use None option when using the aes-gcm or aes-ccm encryption algorithms.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dh_group": {
"type": "array",
"description": "Choose the acceptable Diffie Hellman (DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.encryption_algos": {
"type": "array",
"description": "Choose one or more encryption algorithms.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.prf": {
"type": "array",
"description": "Select PseudoRandomFunction for IKE SA.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days": {
      "type": "object",
"description": "Set Duration in days.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.ike_reauth_timeout": [
      "reauth_disabled",
      "reauth_timeout_days",
      "reauth_timeout_hours"
      ]
}
},
{
"name": "list_ike_phase1_profiles",
"description": "List IKE Phase 1 Profile.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike_phase1_profiles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_ike_phase1_profile",
"description": "DELETE IKE Phase 1 Profile.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/ike_phase1_profiles/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a ike_phase1_profile",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.ike_phase1_profile.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ike_phase1_profileDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike_phase1_profileDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_ike_phase1_profile",
"description": "GET IKE Phase1 profile configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike_phase1_profiles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ike-phase2-profiles": {
"name": "ike-phase2-profiles",
"displayName": "Ike Phase2 Profiles",
"operations": [
{
"name": "create_ike_phase2_profile",
"description": "Create IKE Phase2 Profile.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/ike_phase2_profiles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of ike_phase2_profile",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.ike_phase2_profile.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/viewsike_phase2_profileCreateSpecType"
}
],
"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 ike_phase2_profileCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike_phase2_profileCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike_phase2_profileCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase2 profile specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication_algos": {
      "type": "array",
"description": "Choose one or more Authentication Algorithm. Use None option when using the aes-gcm or aes-ccm encryption algorithms.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dh_group_set": {
"type": "object",
"description": "Choose the acceptable Diffie Hellman(DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dh_group_set.dh_groups": {
"type": "array",
"description": "Choose the acceptable Diffie Hellman(DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_pfs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.encryption_algos": {
"type": "array",
"description": "Choose one or more encryption algorithms.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.pfs_mode": [
"dh_group_set",
"disable_pfs"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_ike_phase2_profile",
"description": "Replace IKE Phase2 Profile configuration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/ike_phase2_profiles/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a ike_phase2_profile",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.ike_phase2_profile.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/viewsike_phase2_profileReplaceSpecType"
}
],
"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 ike_phase2_profileReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike_phase2_profileReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike_phase2_profileReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase2 profile configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication_algos": {
      "type": "array",
"description": "Choose one or more Authentication Algorithm. Use None option when using the aes-gcm or aes-ccm encryption algorithms.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dh_group_set": {
"type": "object",
"description": "Choose the acceptable Diffie Hellman(DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dh_group_set.dh_groups": {
"type": "array",
"description": "Choose the acceptable Diffie Hellman(DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_pfs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.encryption_algos": {
"type": "array",
"description": "Choose one or more encryption algorithms.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.pfs_mode": [
"dh_group_set",
"disable_pfs"
]
}
},
{
"name": "list_ike_phase2_profiles",
"description": "List IKE Phase 2 Profile.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike_phase2_profiles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_ike_phase2_profile",
"description": "DELETE IKE Phase 2 Profile.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/ike_phase2_profiles/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a ike_phase2_profile",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.ike_phase2_profile.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ike_phase2_profileDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike_phase2_profileDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_ike_phase2_profile",
"description": "GET IKE Phase2 profile configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike_phase2_profiles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ike1s": {
"name": "ike1s",
"displayName": "Ike1S",
"operations": [
{
"name": "create_ike1",
"description": "Create IKE Phase1 Profile.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/ike1s",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of ike1",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.ike1.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/schemaike1CreateSpecType"
}
],
"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 ike1CreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike1CreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike1CreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase1 profile specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days": {
      "type": "object",
"description": "Set Duration in days.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.ike_reauth_timeout": [
      "reauth_disabled",
      "reauth_timeout_days",
      "reauth_timeout_hours"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_ike1",
"description": "Replace IKE Phase1 Profile configuration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/ike1s/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a ike1",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.ike1.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/schemaike1ReplaceSpecType"
}
],
"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 ike1ReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike1ReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike1ReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase1 profile configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days": {
      "type": "object",
"description": "Set Duration in days.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_days.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.reauth_timeout_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.ike_reauth_timeout": [
      "reauth_disabled",
      "reauth_timeout_days",
      "reauth_timeout_hours"
      ]
}
},
{
"name": "list_ike1s",
"description": "List IKE Phase 1 Profile.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike1s",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_ike1",
"description": "DELETE IKE Phase 1 Profile.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/ike1s/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a ike1",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.ike1.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ike1DeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike1DeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_ike1",
"description": "GET IKE Phase1 profile configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike1s/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ike2s": {
"name": "ike2s",
"displayName": "Ike2S",
"operations": [
{
"name": "create_ike2",
"description": "Create IKE Phase2 Profile.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/ike2s",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of ike2",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.ike2.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/schemaike2CreateSpecType"
}
],
"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 ike2CreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike2CreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike2CreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase2 profile specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dh_group_set": {
"type": "object",
"description": "Choose the acceptable Diffie Hellman(DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dh_group_set.dh_groups": {
"type": "array",
"description": "Group or collection configuration",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_pfs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.pfs_mode": [
"dh_group_set",
"disable_pfs"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_ike2",
"description": "Replace IKE Phase2 Profile configuration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/ike2s/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a ike2",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.ike2.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/schemaike2ReplaceSpecType"
}
],
"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 ike2ReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike2ReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ike2ReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the IKE Phase2 profile configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dh_group_set": {
"type": "object",
"description": "Choose the acceptable Diffie Hellman(DH) Group or Groups that you are willing to accept as part of this profile.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dh_group_set.dh_groups": {
"type": "array",
"description": "Group or collection configuration",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_pfs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours": {
      "type": "object",
"description": "Input Hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_hours.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes": {
      "type": "object",
"description": "Set IKE Key Lifetime in minutes.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ike_keylifetime_minutes.duration": {
      "type": "integer",
"description": "Configuration parameter for duration",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 300,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_keylifetime": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.ike_key_lifetime": [
      "ike_keylifetime_hours",
      "ike_keylifetime_minutes",
      "use_default_keylifetime"
      ],
"spec.pfs_mode": [
"dh_group_set",
"disable_pfs"
]
}
},
{
"name": "list_ike2s",
"description": "List IKE Phase 2 Profile.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike2s",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_ike2",
"description": "DELETE IKE Phase 2 Profile.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/ike2s/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a ike2",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.ike2.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ike2DeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ike2DeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_ike2",
"description": "GET IKE Phase2 profile configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ike2s/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"implicit-labels": {
"name": "implicit-labels",
"displayName": "Implicit Labels",
"operations": [
{
"name": "list_implicit_labels",
"description": "GET Implicit Labels.",
"method": "GET",
"path": "/api/config/namespaces/system/implicit_labels",
      "dangerLevel": "low",
"parameters": [
{
"name": "query",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "key",
      "in": "query",
"required": false,
"type": "string"
},
{
"name": "value",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "key_classes",
      "in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"label": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "label",
"type": "array",
"description": "List of labels as Query response."
}
]
}
]
},
	"incidents": {
"name": "incidents",
"displayName": "Incidents",
"operations": [
{
"name": "create_incident",
"description": "Security Incidents Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/incidents",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch security incidents.",
"title": "Security Incidents Request",
"x-displayname": "Security Incidents Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityIncidentsRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name. The response\nwill be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the security incidents response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security incidents whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be...",
"x-f5xc-description-medium": "Fetch security incidents whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of security incidents returned in the response\nOptional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of security incidents returned in the response Optional: If not specified, first or last 500 security events that matches the...",
"x-f5xc-description-medium": "Limits the number of security incidents returned in the response Optional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security incidents for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security incidents for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security incident may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security incidents matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={app_type=\"blogging_app\"}",
"x-f5xc-example": "\"query={app_type=\"blogging_app\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the security incident may be specified in the query. Vh_name - name of the virtual host src_site - source site city ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of security incidents (or all security incidents) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of security events until there are no more security events left to return. The number of messages in each\nbatch is determined by the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of security incidents (or all security incidents) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of security incidents (or all security incidents) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of security events until there are no more security events left to...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"title": "sort by",
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: default is sort by last_event_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/app_securitySearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security incidents whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch security incidents whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityIncidentsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityIncidentsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"incidents": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityIncidentsRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name. The response\nwill be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of security incidents returned in the response\nOptional: If not specified, first or last 500 security events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security incidents for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security incident may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security incidents matching ALL the matchers will be returned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of security incidents (or all security incidents) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of security events until there are no more security events left to return. The number of messages in each\nbatch is determined by the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations."
},
{
"field": "incidents",
"type": "array",
"description": "List of security incidents that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security incidents using the scroll\nrequest.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityIncidentsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"incidents-aggregation": {
"name": "incidents-aggregation",
"displayName": "Incidents Aggregation",
"operations": [
{
"name": "create_incidents_aggregation",
"description": "Security Incidents Aggregation Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/incidents/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for security incidents.",
"title": "Security Incidents Aggregation Request",
"x-displayname": "Security Incidents Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityIncidentsAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.\nThe response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over security incidents response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over security incidents response. If the number of security incidents that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security incidents whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be...",
"x-f5xc-description-medium": "Fetch security incidents whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security incidents for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security incidents for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security incidents matching ALL the matchers will be\nreturned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security incidents originating from\nCalifornia, United States.\n\nOptional: If not specified, all security incidents matching the given tenant and namespace will be returned in\nthe response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={app_type=\"blogging_app\"}",
"x-f5xc-example": "\"query={app_type=\"blogging_app\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the security event may be specified in the query. Vh_name - name of the virtual host src_site - source site city ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch security incidents whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch security incidents whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for security incidents.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityIncidentsAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityIncidentsAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityIncidentsAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.\nThe response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch security incidents for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nVh_name - name of the virtual host\nsrc_site - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then security incidents matching ALL the matchers will be\nreturned in the response.\nExample: query={country=\"United States\", city=\"California\"} will return all security incidents originating from\nCalifornia, United States.\n\nOptional: If not specified, all security incidents matching the given tenant and namespace will be returned in\nthe response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch security incidents whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations. The aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of security incidents that matched the query."
}
]
}
]
},
	"incidents-scroll": {
"name": "incidents-scroll",
"displayName": "Incidents Scroll",
"operations": [
{
"name": "list_incidents_scroll",
"description": "Security Incidents Scroll Query.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/app_security/incidents/scroll",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "scroll_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"incidents": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations."
},
{
"field": "incidents",
"type": "array",
"description": "List of security incidents that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security incidents using the scroll\nrequest.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityIncidentsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
},
{
"name": "create_incidents_scroll",
"description": "Security Incidents Scroll Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/incidents/scroll",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Scroll request is used to fetch large number of security incidents in multiple batches with each SecurityIncidentsResponse\ncontaining no more than 500 messages. To scroll through more than 500 or all security incidents, one can use the\nSecurityIncidentsScrollRequest. Use the scroll_id returned in the SecurityIncidentsResponse to fetch the next batch\nof security events and one can continue this process till the scroll_id returned is \"\" which indicates no more\nmessages to scroll.",
"title": "Security Incidents Scroll Request",
"x-displayname": "Security Incidents Scroll Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SecurityIncidentsScrollRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Fetch security incidents for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch security incidents for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"title": "scroll id",
"x-displayname": "Scroll ID",
"x-ves-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==.",
"x-f5xc-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Scroll request is used to fetch large number of security incidents in multiple batches with each SecurityIncidentsResponse containing no more than...",
"x-f5xc-description-medium": "Scroll request is used to fetch large number of security incidents in multiple batches with each SecurityIncidentsResponse containing no more than 500 messages. To scroll through more than 500 or all security incidents, one can use the SecurityIncidentsScrollRequest. Use the scroll_id returned...",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySecurityIncidentsScrollRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySecurityIncidentsScrollRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"incidents": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySecurityIncidentsScrollRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Fetch security incidents for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security incidents response. If the number of security incidents\nthat matched the query is large and cannot be returned in a single response message, user can GET helpful\ninsights/summary using aggregations."
},
{
"field": "incidents",
"type": "array",
"description": "List of security incidents that matched the query. Contains no more than 500 messages."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of security incidents using the scroll\nrequest.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SecurityIncidentsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of security events that matched the query."
}
]
}
]
},
	"infraprotect": {
"name": "infraprotect",
"displayName": "Infraprotect",
"operations": [
{
"name": "create_infraprotect",
"description": "Create DDoS transit Prefix.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of infraprotect_asn_prefix",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.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/infraprotect_asn_prefixCreateSpecType"
}
],
"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 infraprotect_asn_prefixCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_asn_prefixCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotect_asn_prefixCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a DDoS transit Prefix.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.asn.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix": {
"type": "string",
"description": "Prefix",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_infraprotect",
"description": "Replace DDoS transit Prefix.",
"method": "PUT",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a infraprotect_asn_prefix",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.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/infraprotect_asn_prefixReplaceSpecType"
}
],
"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 infraprotect_asn_prefixReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_asn_prefixReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotect_asn_prefixReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Amends a DDoS transit Prefix.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_infraprotect",
"description": "List Infraprotect ASN Prefix.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_infraprotect",
"description": "DELETE Infraprotect ASN Prefix.",
"method": "DELETE",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a infraprotect_asn_prefix",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_asn_prefixDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_asn_prefixDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
}
},
{
"name": "get_infraprotect",
"description": "GET Infraprotect ASN Prefix.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"infraprotect-alert": {
"name": "infraprotect-alert",
"displayName": "Infraprotect Alert",
"operations": [
{
"name": "get_infraprotect_alert",
"description": "DDoS Alert.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/alert/{alert_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "alert_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"misuse_types": {
"type": "array"
},
"ports": {
"type": "array"
},
"prefixes": {
"type": "array"
},
"tcp_flags": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "misuse_types",
"type": "array",
"description": "List of misuse types involved in the alert."
},
{
"field": "ports",
"type": "array",
"description": "List of ports involved in the alert."
},
{
"field": "prefixes",
"type": "array",
"description": "List of prefixes involved in the alert."
},
{
"field": "tcp_flags",
"type": "array",
"description": "TCP flags information for the alert."
}
]
}
]
},
	"infraprotect-alert-to-event": {
"name": "infraprotect-alert-to-event",
"displayName": "Infraprotect Alert To Event",
"operations": [
{
"name": "replace_infraprotect_alert_to_event",
"description": "Link Alert to Event.",
"method": "PUT",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/alert/{alert_id}/to_event",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "alert_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to add an alert to event (link them together)",
"title": "Add Alert to Event",
"x-displayname": "Add Alert to Event.",
"x-ves-proto-message": "ves.io.schema.infraprotect.AddAlertToEventRequest",
"properties": {
"alert_id": {
"type": "string",
"description": "Alert to be link with an event.",
"title": "Alert ID",
"x-displayname": "Alert ID",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"event_id": {
"type": "string",
"description": "Event to be link with an alert.",
"title": "Event ID",
"x-displayname": "Event ID",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to add an alert to event (link them together).",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectAddAlertToEventRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectAddAlertToEventRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectAddAlertToEventRequest"
},
"fieldMetadata": {
"alert_id": {
"type": "string",
"description": "Alert to be link with an event.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Event to be link with an alert.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"infraprotect-alerts": {
"name": "infraprotect-alerts",
"displayName": "Infraprotect Alerts",
"operations": [
{
"name": "create_infraprotect_alert",
"description": "DDoS Alerts.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/alerts",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET customer alerts with optional filtering.",
"title": "Alerts request",
"x-displayname": "Alerts request.",
"x-ves-oneof-field-alert_type": "[\"alert_type_ddos\",\"alert_type_infrastructure\"]",
"x-ves-proto-message": "ves.io.schema.infraprotect.ListAlertsRequest",
"properties": {
"alert_type_ddos": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for alert type ddos.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"alert_type_infrastructure": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Event ID when we want to filter by an event start and end time.\n\nOptional: If not specified, then no events filtering occurs.",
"title": "Event ID",
"x-displayname": "Event ID",
"x-ves-example": "12345",
"x-f5xc-example": "12345",
"x-f5xc-description-short": "Event ID when we want to filter by an event start and end time. Optional: If not specified, then no events filtering occurs.",
"x-f5xc-description-medium": "Event ID when we want to filter by an event start and end time. Optional: If not specified, then no events filtering occurs.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.\n\nOptional: If not specified, then no network filtering occurs.",
"title": "Network ID",
"x-displayname": "Network ID.",
"x-ves-example": "12345",
"x-f5xc-example": "12345",
"x-f5xc-description-short": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.",
"x-f5xc-description-medium": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant. Optional: If not specified, then no network filtering occurs.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET customer alerts with optional filtering.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectListAlertsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectListAlertsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {
"alerts": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectListAlertsRequest"
},
"fieldMetadata": {
"alert_type_ddos": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"alert_type_infrastructure": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Event ID when we want to filter by an event start and end time.\n\nOptional: If not specified, then no events filtering occurs.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.\n\nOptional: If not specified, then no network filtering occurs.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"alert_type": [
"alert_type_ddos",
"alert_type_infrastructure"
]
},
"responseSummary": [
{
"field": "alerts",
"type": "array",
"description": "List if alerts."
}
]
}
]
},
	"infraprotect-event": {
"name": "infraprotect-event",
"displayName": "Infraprotect Event",
"operations": [
{
"name": "get_infraprotect_event",
"description": "Event details.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "event",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_infraprotect_event",
"description": "Edit event.",
"method": "PUT",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET a single event.",
"title": "Event request",
"x-displayname": "Event request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.EditEventRequest",
"properties": {
"description": {
"type": "string",
"description": "New description of the event.",
"title": "Description",
"x-displayname": "Description.",
"x-ves-example": "New description of the event.",
"x-f5xc-example": "New description of the event",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"end_time": {
"type": "string",
"description": "New end time of the event (note that end time is always set manually)",
"title": "End time",
"format": "date-time",
"x-displayname": "End time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "New end time of the event (note that end time is always set manually).",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_attachments": {
"type": "array",
"description": "List of event's attachments.",
"title": "Attachments",
"items": {
"$ref": "#/components/schemas/infraprotectAttachment"
},
"x-displayname": "Attachments.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "ID of the event we want to edit.",
"title": "Alert ID",
"x-displayname": "Alert ID",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"name": {
"type": "string",
"description": "New name of the event.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Event_123",
"x-f5xc-example": "event_123",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectEditEventRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectEditEventRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectEditEventRequest"
},
"fieldMetadata": {
"description": {
"type": "string",
"description": "New description of the event.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "New end time of the event (note that end time is always set manually)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_attachments": {
"type": "array",
"description": "List of event's attachments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "ID of the event we want to edit.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "New name of the event.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "event",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-event-alerts": {
"name": "infraprotect-event-alerts",
"displayName": "Infraprotect Event Alerts",
"operations": [
{
"name": "list_infraprotect_event_alerts",
"description": "Event alerts.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/alerts",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"alerts": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "alerts",
"type": "array",
"description": "List of alerts related to the event."
}
]
}
]
},
	"infraprotect-event-attachments": {
"name": "infraprotect-event-attachments",
"displayName": "Infraprotect Event Attachments",
"operations": [
{
"name": "list_infraprotect_event_attachments",
"description": "Event attachments.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/attachments",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"attachments": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "attachments",
"type": "array",
"description": "List of Attachments related to the event."
}
]
}
]
},
	"infraprotect-event-detail": {
"name": "infraprotect-event-detail",
"displayName": "Infraprotect Event Detail",
"operations": [
{
"name": "delete_infraprotect_event_detail",
"description": "DELETE event detail.",
"method": "DELETE",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/detail/{event_detail_id}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "event_detail_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object"
}
},
{
"name": "replace_infraprotect_event_detail",
"description": "Edit event detail.",
"method": "PUT",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/detail/{event_detail_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "event_detail_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update a single event detail.",
"title": "Request to update event detail",
"x-displayname": "Update event detail request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.EditEventDetailRequest",
"properties": {
"attachments": {
"type": "array",
"description": "All attachments on an event details, missing will be removed, extras will be added.",
"title": "Attachments",
"items": {
"$ref": "#/components/schemas/infraprotectAttachment"
},
"x-displayname": "Attachments.",
"x-f5xc-description-short": "All attachments on an event details, missing will be removed, extras will be added.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "Description of the event detail.",
"title": "Description",
"x-displayname": "Description.",
"x-ves-example": "Actions taken: ...",
"x-f5xc-example": "Actions taken...",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"event_detail_id": {
"type": "string",
"description": "Event detail ID we want to update.",
"title": "Event Detail ID",
"x-displayname": "Event Detail ID.",
"x-ves-example": "00000000-0000-4000-8000-7248e7cee302.",
"x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"event_id": {
"type": "string",
"description": "Event ID we want to edit the event detail for.",
"title": "Event ID",
"x-displayname": "Event ID",
"x-ves-example": "00000000-0000-4000-8000-7248e7cee302.",
"x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302",
"x-f5xc-description-short": "Event ID we want to edit the event detail for.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"time": {
"type": "string",
"description": "Time of the event detail\nFormat: RFC3339.",
"title": "Time",
"format": "date-time",
"x-displayname": "Time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "Time of the event detail Format: RFC3339.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "date-time",
"minLength": 8,
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"formatDescription": "Time format (e.g., 14:30:00)",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"title": {
"type": "string",
"description": "Title of the event of the event detail.",
"title": "Title",
"x-displayname": "Title",
"x-ves-example": "Actions taken so far.",
"x-f5xc-example": "Actions taken so far",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to update a single event detail.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectEditEventDetailRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectEditEventDetailRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectEditEventDetailRequest"
},
"fieldMetadata": {
"attachments": {
"type": "array",
"description": "All attachments on an event details, missing will be removed, extras will be added.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "Description of the event detail.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_detail_id": {
"type": "string",
"description": "Event detail ID we want to update.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Event ID we want to edit the event detail for.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time": {
"type": "string",
"description": "Time of the event detail\nFormat: RFC3339.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "date-time",
"minLength": 8,
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"formatDescription": "Time format (e.g., 14:30:00)",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"title": {
"type": "string",
"description": "Title of the event of the event detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "detail",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-event-details": {
"name": "infraprotect-event-details",
"displayName": "Infraprotect Event Details",
"operations": [
{
"name": "list_infraprotect_event_details",
"description": "List of event details.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/details",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"details": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "details",
"type": "array",
"description": "List of event details the event may have."
}
]
},
{
"name": "create_infraprotect_event_detail",
"description": "Add Event Detail.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/details",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to add a single event detail to an event.",
"title": "Request to add event detail",
"x-displayname": "Add event detail request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.AddEventDetailRequest",
"properties": {
"attachments": {
"type": "array",
"description": "All attachments on an event details.",
"title": "Attachments",
"items": {
"$ref": "#/components/schemas/infraprotectAttachment"
},
"x-displayname": "Attachments.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "Description of the event detail.",
"title": "Description",
"x-displayname": "Description.",
"x-ves-example": "Actions taken: ...",
"x-f5xc-example": "Actions taken...",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"event_id": {
"type": "string",
"description": "Event ID we want to list the event details for.",
"title": "Event ID",
"x-displayname": "Event ID",
"x-ves-example": "00000000-0000-4000-8000-7248e7cee302.",
"x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302",
"x-f5xc-description-short": "Event ID we want to list the event details for.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"time": {
"type": "string",
"description": "Time of the event detail\nFormat: RFC3339.",
"title": "Time",
"format": "date-time",
"x-displayname": "Time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "Time of the event detail Format: RFC3339.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "date-time",
"minLength": 8,
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"formatDescription": "Time format (e.g., 14:30:00)",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"title": {
"type": "string",
"description": "Title of the event of the event detail.",
"title": "Title",
"x-displayname": "Title",
"x-ves-example": "Actions taken so far.",
"x-f5xc-example": "Actions taken so far",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to add a single event detail to an event.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectAddEventDetailRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectAddEventDetailRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectAddEventDetailRequest"
},
"fieldMetadata": {
"attachments": {
"type": "array",
"description": "All attachments on an event details.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "Description of the event detail.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Event ID we want to list the event details for.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time": {
"type": "string",
"description": "Time of the event detail\nFormat: RFC3339.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "date-time",
"minLength": 8,
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"formatDescription": "Time format (e.g., 14:30:00)",
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"title": {
"type": "string",
"description": "Title of the event of the event detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "detail",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-event-mitigation-annotations": {
"name": "infraprotect-event-mitigation-annotations",
"displayName": "Infraprotect Event Mitigation Annotations",
"operations": [
{
"name": "list_infraprotect_event_mitigation_annotations",
"description": "Event mitigation annotation.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/mitigation_annotations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "event_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"mitigations": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "mitigations",
"type": "array",
"description": "List of mitigations related to the event."
}
]
}
]
},
	"infraprotect-events": {
"name": "infraprotect-events",
"displayName": "Infraprotect Events",
"operations": [
{
"name": "create_infraprotect_event",
"description": "List of events.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET a list of events.",
"title": "List of events request",
"x-displayname": "Events",
"x-ves-proto-message": "ves.io.schema.infraprotect.ListEventsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mitigation_id": {
"type": "string",
"description": "Filter events by mitigation\n\nOptional: If not specified, then events are returned regardless of mitigation.",
"title": "Mitigation",
"x-displayname": "Mitigation.",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-description-short": "Filter events by mitigation Optional: If not specified, then events are returned regardless of mitigation.",
"x-f5xc-description-medium": "Filter events by mitigation Optional: If not specified, then events are returned regardless of mitigation.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "Filter events by network\n\nOptional: If not specified, then all tenant's networks are considerate.",
"title": "Network",
"x-displayname": "Network",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-description-short": "Filter events by network Optional: If not specified, then all tenant's networks are considerate.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectListEventsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectListEventsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {
"events": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectListEventsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mitigation_id": {
"type": "string",
"description": "Filter events by mitigation\n\nOptional: If not specified, then events are returned regardless of mitigation.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "Filter events by network\n\nOptional: If not specified, then all tenant's networks are considerate.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "events",
"type": "array",
"description": "Recorder events filtered by events requests."
}
]
}
]
},
	"infraprotect-events-summary": {
"name": "infraprotect-events-summary",
"displayName": "Infraprotect Events Summary",
"operations": [
{
"name": "list_infraprotect_events_summary",
"description": "Simple events view.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/events_summary",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "alert_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"events": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "events",
"type": "array",
"description": "List of events."
}
]
}
]
},
	"infraprotect-infraprotect-access": {
"name": "infraprotect-infraprotect-access",
      "displayName": "Infraprotect Infraprotect Access",
      "operations": [
{
"name": "list_infraprotect_infraprotect_access",
      "description": "Customer access.",
      "method": "GET",
"path": "/api/infraprotect/namespaces/system/infraprotect/access",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "l3l4",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-l3l4-by-application": {
"name": "infraprotect-l3l4-by-application",
"displayName": "Infraprotect L3L4 By Application",
"operations": [
{
"name": "create_infraprotect_l3l4_by_application",
"description": "L3l4 Application traffic Query.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_application/{network_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "network_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Used to display Application (aka protocol) by tenant.",
"title": "l3l4 Application Request",
"x-displayname": "L3l4 Application Request.",
"x-ves-proto-message": "ves.io.schema.graph.l3l4.ByApplicationRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "The network ID.",
"title": "NetworkId",
"x-displayname": "NetworkId",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4TrafficUnit"
}
],
"x-f5xc-description-short": "Configuration parameter for traffic unit.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Used to display Application (aka protocol) by tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for l3l4ByApplicationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for l3l4ByApplicationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"in": {
"type": "array"
},
"out": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for l3l4ByApplicationRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "The network ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"type": "string",
"description": "Used to define the unit the results should be in.\n\nUnknown or undefined unit.\nBits per second traffic unit.\nPackets per second traffic unit.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TrafficUnitUnknown"
}
},
"responseSummary": [
{
"field": "in",
"type": "array",
"description": "List of data."
},
{
"field": "out",
"type": "array",
"description": "List of data."
}
]
}
]
},
	"infraprotect-l3l4-by-mitigation": {
"name": "infraprotect-l3l4-by-mitigation",
"displayName": "Infraprotect L3L4 By Mitigation",
"operations": [
{
"name": "create_infraprotect_l3l4_by_mitigation",
"description": "L3l4 Mitigation Traffic Query.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_mitigation/{mitigation_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "mitigation_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Used to display Zone by tenant.",
"title": "l3l4 Mitigation Request",
"x-displayname": "L3l4 Zone Request.",
"x-ves-proto-message": "ves.io.schema.graph.l3l4.ByMitigationRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mitigation_id": {
"type": "string",
"description": "The mitigation ID.",
"title": "MitigationId",
"x-displayname": "MitigationId.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4MitigationSeriesSort"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"top_n": {
"type": "integer",
"description": "TopN define the number of series returned after sort.\n\nOptional: If not specified all timeseries are returned.",
"title": "Top N",
"format": "int32",
"x-displayname": "Top N",
"x-ves-example": "3",
"x-f5xc-example": "3",
"x-f5xc-description-short": "TopN define the number of series returned after sort. Optional: If not specified all timeseries are returned.",
"x-f5xc-description-medium": "TopN define the number of series returned after sort. Optional: If not specified all timeseries are returned.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4TrafficUnit"
}
],
"x-f5xc-description-short": "Configuration parameter for traffic unit.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for l3l4ByMitigationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for l3l4ByMitigationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"rates": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for l3l4ByMitigationRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mitigation_id": {
"type": "string",
"description": "The mitigation ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Used to define the sort of the metrics before returning the top\n\nUnknown or undefined type\nSort by maxfor the timerange.\nSort by average bytes for the timerange.\nSort by pct95 bytes for the timerange.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MitigationSeriesSortUnknown"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"top_n": {
"type": "integer",
"description": "TopN define the number of series returned after sort.\n\nOptional: If not specified all timeseries are returned.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"type": "string",
"description": "Used to define the unit the results should be in.\n\nUnknown or undefined unit.\nBits per second traffic unit.\nPackets per second traffic unit.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TrafficUnitUnknown"
}
},
"responseSummary": [
{
"field": "rates",
"type": "array",
"description": "List of data."
}
]
}
]
},
	"infraprotect-l3l4-by-network": {
"name": "infraprotect-l3l4-by-network",
"displayName": "Infraprotect L3L4 By Network",
"operations": [
{
"name": "create_infraprotect_l3l4_by_network",
"description": "L3l4 Network Traffic Query.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_network/{network_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "network_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Used to display Network (aka protocol) by tenant.",
"title": "l3l4 Network Request",
"x-displayname": "L3l4 Network Request.",
"x-ves-proto-message": "ves.io.schema.graph.l3l4.ByNetworkRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "The network ID.",
"title": "NetworkId",
"x-displayname": "NetworkId",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4TrafficUnit"
}
],
"x-f5xc-description-short": "Configuration parameter for traffic unit.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Used to display Network (aka protocol) by tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for l3l4ByNetworkRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for l3l4ByNetworkRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"in": {
"type": "array"
},
"out": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for l3l4ByNetworkRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "The network ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"type": "string",
"description": "Used to define the unit the results should be in.\n\nUnknown or undefined unit.\nBits per second traffic unit.\nPackets per second traffic unit.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TrafficUnitUnknown"
}
},
"responseSummary": [
{
"field": "in",
"type": "array",
"description": "List of data."
},
{
"field": "out",
"type": "array",
"description": "List of data."
}
]
}
]
},
	"infraprotect-l3l4-by-zone": {
"name": "infraprotect-l3l4-by-zone",
"displayName": "Infraprotect L3L4 By Zone",
"operations": [
{
"name": "create_infraprotect_l3l4_by_zone",
"description": "L3l4 Zone Traffic Query.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_zone/{network_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "network_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Used to display Zone by tenant.",
"title": "l3l4 Zone Request",
"x-displayname": "L3l4 Zone Request.",
"x-ves-proto-message": "ves.io.schema.graph.l3l4.ByZoneRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "The network ID.",
"title": "NetworkId",
"x-displayname": "NetworkId",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"routed_traffic": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4RoutedTraffic"
}
],
"x-f5xc-description-short": "Configuration parameter for routed traffic.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4TrafficUnit"
}
],
"x-f5xc-description-short": "Configuration parameter for traffic unit.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for l3l4ByZoneRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for l3l4ByZoneRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"in": {
"type": "array"
},
"out": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for l3l4ByZoneRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "The network ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"routed_traffic": {
"type": "string",
"description": "Used to define the routed traffic (Pre or POST scrub)\n\nUnknown or undefined routed traffic (use default)\nPreScrub traffic\nPostScrub traffic (default)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "RoutedTrafficUnknown"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"type": "string",
"description": "Used to define the unit the results should be in.\n\nUnknown or undefined unit.\nBits per second traffic unit.\nPackets per second traffic unit.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TrafficUnitUnknown"
}
},
"responseSummary": [
{
"field": "in",
"type": "array",
"description": "List of data."
},
{
"field": "out",
"type": "array",
"description": "List of data."
}
]
}
]
},
	"infraprotect-l3l4-event-count": {
"name": "infraprotect-l3l4-event-count",
"displayName": "Infraprotect L3L4 Event Count",
"operations": [
{
"name": "create_infraprotect_l3l4_event_count",
"description": "L3l4 Event count.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/graph/l3l4/event_count/{network_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "network_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Used to display Event counts for a network.",
"title": "l3l4 EventsCount Request",
"x-displayname": "L3l4 Events Count Request.",
"x-ves-proto-message": "ves.io.schema.graph.l3l4.EventCountRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "2021-11-11T06:58:11.",
"x-f5xc-example": "2021-11-11T06:58:11",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "The network ID we want the data for. If empty or * is provided then all networks data is returned.",
"title": "NetworkId",
"x-displayname": "NetworkId",
"x-ves-example": "00000000-0000-4000-8000-2e540be20504.",
"x-f5xc-example": "00000000-0000-4000-8000-2e540be20504",
"x-f5xc-description-short": "The network ID we want the data for. If empty or * is provided then all networks data is returned.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-1y.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "2021-11-11T06:58:11.",
"x-f5xc-example": "2021-11-11T06:58:11",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Optional: If not specified, then the start_time will be evaluated to <current time>-1y.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then the step will be evaluated to 1d.",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "1d",
"x-f5xc-example": "1d",
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d ...",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Optional: If not specified, then the step will be evaluated to 1d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Used to display Event counts for a network.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for l3l4EventCountRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for l3l4EventCountRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"events": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for l3l4EventCountRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "The network ID we want the data for. If empty or * is provided then all networks data is returned.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-1y.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then the step will be evaluated to 1d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "events",
"type": "array",
"description": "List of timelines with event count metrics. Currently two metrics are considered - bounded events and ongoing events."
}
]
}
]
},
	"infraprotect-l3l4-top-talkers": {
"name": "infraprotect-l3l4-top-talkers",
"displayName": "Infraprotect L3L4 Top Talkers",
"operations": [
{
"name": "create_infraprotect_l3l4_top_talker",
"description": "L3l4 Top talkers Query.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/graph/l3l4/top_talkers/{network_id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "network_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Used to display Top Talkers for a network.",
"title": "l3l4 TopTalkers Request",
"x-displayname": "L3l4 Top Talkers Request.",
"x-ves-proto-message": "ves.io.schema.graph.l3l4.TopTalkersRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "The network ID.",
"title": "NetworkId",
"x-displayname": "NetworkId",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_type": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4TrafficType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_unit": {
"allOf": [
{
"$ref": "#/components/schemas/l3l4TrafficUnit"
}
],
"x-f5xc-description-short": "Configuration parameter for traffic unit.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Used to display Top Talkers for a network.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for l3l4TopTalkersRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for l3l4TopTalkersRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for l3l4TopTalkersRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "The network ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"traffic_type": {
"type": "string",
"description": "Used to define the type the results should be in.\n\nUnknown or undefined type.\nExternal traffic.\nInternal traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TrafficTypeUnknown"
},
"traffic_unit": {
"type": "string",
"description": "Used to define the unit the results should be in.\n\nUnknown or undefined unit.\nBits per second traffic unit.\nPackets per second traffic unit.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TrafficUnitUnknown"
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of data."
},
{
"field": "traffic_unit",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-mitigation": {
"name": "infraprotect-mitigation",
"displayName": "Infraprotect Mitigation",
"operations": [
{
"name": "get_infraprotect_mitigation",
"description": "Mitigation details.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "mitigation_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"details": {
"type": "string"
},
"prefixes": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "details",
"type": "string",
"description": "Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such."
},
{
"field": "prefixes",
"type": "array",
"description": "Prefixes associated to mitigation."
}
]
}
]
},
	"infraprotect-mitigation-annotations": {
"name": "infraprotect-mitigation-annotations",
"displayName": "Infraprotect Mitigation Annotations",
"operations": [
{
"name": "list_infraprotect_mitigation_annotations",
"description": "Mitigation annotations.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/annotations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "mitigation_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"annotations": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "annotations",
"type": "array",
"description": "Mitigation annotations of a mitigation."
}
]
}
]
},
	"infraprotect-mitigation-countermeasures": {
"name": "infraprotect-mitigation-countermeasures",
"displayName": "Infraprotect Mitigation Countermeasures",
"operations": [
{
"name": "list_infraprotect_mitigation_countermeasures",
"description": "Mitigation Countermeasures.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/countermeasures",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "mitigation_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "aif_and_http_url_regular_expression",
"type": "object",
"description": ""
},
{
"field": "dns_auth",
      "type": "object",
"description": ""
},
{
"field": "dns_malformed",
"type": "object",
"description": ""
},
{
"field": "dns_nxdomain_ratelimiting",
"type": "object",
"description": ""
},
{
"field": "dns_object_ratelimiting",
"type": "object",
"description": ""
},
{
"field": "dns_ratelimiting",
"type": "object",
"description": ""
},
{
"field": "dns_regular_expression",
"type": "object",
"description": ""
},
{
"field": "dns_scoping",
"type": "object",
"description": ""
},
{
"field": "http_malformed",
"type": "object",
"description": ""
},
{
"field": "http_rate_limiting",
"type": "object",
"description": ""
},
{
"field": "http_scoping",
"type": "object",
"description": ""
},
{
"field": "invalid_packets",
"type": "object",
"description": ""
},
{
"field": "ip_address_filter_list",
"type": "object",
"description": ""
},
{
"field": "ip_location_filter_list",
"type": "object",
"description": ""
},
{
"field": "ip_location_policing",
"type": "object",
"description": ""
},
{
"field": "packet_header_filtering",
"type": "object",
"description": ""
},
{
"field": "payload_regular_expression",
"type": "object",
"description": ""
},
{
"field": "per_connection_flood_protection",
"type": "object",
"description": ""
},
{
"field": "protocol_baselines",
"type": "object",
"description": ""
},
{
"field": "proxy_list_threshold_exceptions",
"type": "object",
"description": ""
},
{
"field": "shaping",
      "type": "object",
"description": ""
},
{
"field": "sip_malformed",
"type": "object",
"description": ""
},
{
"field": "sip_request_limiting",
"type": "object",
"description": ""
},
{
"field": "tcp_connection_limiting",
"type": "object",
"description": ""
},
{
"field": "tcp_connection_reset",
"type": "object",
"description": ""
},
{
"field": "tcp_syn_auth",
      "type": "object",
"description": ""
},
{
"field": "tls_negotiation",
"type": "object",
"description": ""
},
{
"field": "udp_reflection_amp",
"type": "object",
"description": ""
},
{
"field": "udp_session_authentication",
      "type": "object",
"description": ""
},
{
"field": "zombie_detection",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-mitigation-ips": {
"name": "infraprotect-mitigation-ips",
"displayName": "Infraprotect Mitigation Ips",
"operations": [
{
"name": "list_infraprotect_mitigation_ips",
"description": "Mitigation IPs.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/ips",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "mitigation_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"ips": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "ips",
"type": "array",
"description": "List of IP addresses along with log count."
}
]
}
]
},
	"infraprotect-mitigations": {
"name": "infraprotect-mitigations",
"displayName": "Infraprotect Mitigations",
"operations": [
{
"name": "create_infraprotect_mitigation",
"description": "List of mitigations.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET a list of mitigations.",
"title": "Mitigations request",
"x-displayname": "Mitigations request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.ListMitigationsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Filter mitigations by an event\n\nOptional: If not specified, then all tenant's events are considerate.",
"title": "Event",
"x-displayname": "Event",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-description-short": "Filter mitigations by an event Optional: If not specified, then all tenant's events are considerate.",
"x-f5xc-description-medium": "Filter mitigations by an event Optional: If not specified, then all tenant's events are considerate.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"network_id": {
"type": "string",
"description": "Filter mitigations by network\n\nOptional: If not specified, then all tenant's networks are considerate.",
"title": "Network",
"x-displayname": "Network",
"x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.",
"x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f",
"x-f5xc-description-short": "Filter mitigations by network Optional: If not specified, then all tenant's networks are considerate.",
"x-f5xc-description-medium": "Filter mitigations by network Optional: If not specified, then all tenant's networks are considerate.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectListMitigationsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectListMitigationsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {
"mitigations": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectListMitigationsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"event_id": {
"type": "string",
"description": "Filter mitigations by an event\n\nOptional: If not specified, then all tenant's events are considerate.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"network_id": {
"type": "string",
"description": "Filter mitigations by network\n\nOptional: If not specified, then all tenant's networks are considerate.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "mitigations",
"type": "array",
"description": "Filtered mitigations."
}
]
}
]
},
	"infraprotect-networks": {
"name": "infraprotect-networks",
"displayName": "Infraprotect Networks",
"operations": [
{
"name": "list_infraprotect_networks",
"description": "List networks.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/networks",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"networks": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "networks",
"type": "array",
"description": "List of networks the customer has."
}
]
}
]
},
	"infraprotect-report": {
"name": "infraprotect-report",
"displayName": "Infraprotect Report",
"operations": [
{
"name": "get_infraprotect_report",
"description": "Report details.",
"method": "GET",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/report/{report_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "report_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "attachment",
"type": "object",
"description": ""
}
]
}
]
},
	"infraprotect-reports": {
"name": "infraprotect-reports",
"displayName": "Infraprotect Reports",
"operations": [
{
"name": "create_infraprotect_report",
"description": "List reports.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect/reports",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET a list of available reports.",
"title": "Reports request",
"x-displayname": "Reports request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.ListReportsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-example": "2021-01-01T00:00:00Z.",
"x-f5xc-example": "2021-01-01T00:00:00Z",
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET a list of available reports.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectListReportsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectListReportsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {
"reports": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for infraprotectListReportsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This request is supported only in system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the start_time will be evaluated to <current time>-3d.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "reports",
"type": "array",
"description": "List of reports available to the tenant."
}
]
}
]
},
	"infraprotect-update-advertisement-status": {
"name": "infraprotect-update-advertisement-status",
"displayName": "Infraprotect Update Advertisement Status",
"operations": [
{
"name": "create_infraprotect_update_advertisement_statu",
"description": "Update Infraprotect Internet prefix advertisement.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_internet_prefix_advertisements/update-advertisement-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to toggle Internet prefix advertisement announcement/withdrawal.",
"title": "Toggle Internet Prefix Advertisement Announcement",
"x-displayname": "Toggle Infraprotect Internet Prefix advertisement Request.",
"x-ves-oneof-field-activation_selection": "[\"activation_announce\",\"activation_withdraw\"]",
"x-ves-proto-message": "ves.io.schema.infraprotect_internet_prefix_advertisement.UpdateInternetPrefixAdvertisementRequest",
"properties": {
"activation_announce": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for activation announce.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"activation_withdraw": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for activation withdraw.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the infraprotect internet prefix advertisement that has to be updated.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Internet-prefix-advertisement-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "internet-prefix-advertisement-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The name of the infraprotect internet prefix advertisement that has to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which internet prefix advertisement status has to be updated.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which internet prefix advertisement status has to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to toggle Internet prefix advertisement announcement/withdrawal.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_internet_prefix_advertisementUpdateInternetPrefixAdvertisementRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_internet_prefix_advertisementUpdateInternetPrefixAdvertisementRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for infraprotect_internet_prefix_advertisementUpdateInternetPrefixAdvertisementRequest"
},
"fieldMetadata": {
"activation_announce": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"activation_withdraw": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the infraprotect internet prefix advertisement that has to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which internet prefix advertisement status has to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"activation_selection": [
"activation_announce",
"activation_withdraw"
]
}
}
]
},
	"infraprotect-update-asn-prefix-irr-override": {
"name": "infraprotect-update-asn-prefix-irr-override",
"displayName": "Infraprotect Update Asn Prefix Irr Override",
"operations": [
{
"name": "create_infraprotect_update_asn_prefix_irr_override",
"description": "Update ASN Prefix IRR Override.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixes/update-asn-prefix-irr-override",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update infraprotect ASN irr override status.",
"title": "Update Infraprotect ASN IRR Override",
"x-displayname": "Update Infraprotect ASN IRR Override Request.",
"x-ves-oneof-field-irr_override": "[]",
"x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.UpdateASNPrefixIRROverrideRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the infraprotect ASN prefix object to be updated.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the infraprotect ASN prefix object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the infraprotect ASN prefix irr override is to be updated.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the infraprotect ASN prefix irr override is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to update infraprotect ASN irr override status.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixIRROverrideRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_asn_prefixUpdateASNPrefixIRROverrideRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixIRROverrideRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the infraprotect ASN prefix object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the infraprotect ASN prefix irr override is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"irr_override": []
}
}
]
},
	"infraprotect-update-asn-prefix-review-status": {
"name": "infraprotect-update-asn-prefix-review-status",
"displayName": "Infraprotect Update Asn Prefix Review Status",
"operations": [
{
"name": "create_infraprotect_update_asn_prefix_review_statu",
"description": "Update ASN Prefix Review Status.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixes/update-asn-prefix-review-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update infraprotect ASN prefix review status.",
"title": "Update Infraprotect ASN Prefix Review Status",
"x-displayname": "Update Infraprotect ASN Prefix Review Status Request.",
"x-ves-oneof-field-review_type": "[\"review_type_approved\",\"review_type_pending\",\"review_type_rejected\"]",
"x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.UpdateASNPrefixReviewStatusRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the infraprotect ASN prefix object to be updated.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the infraprotect ASN prefix object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the infraprotect ASN prefix review status is to be updated.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the infraprotect ASN prefix review status is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"review_type_approved": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for review type approved.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_pending": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for review type pending.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_rejected": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for review type rejected.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to update infraprotect ASN prefix review status.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixReviewStatusRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_asn_prefixUpdateASNPrefixReviewStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixReviewStatusRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the infraprotect ASN prefix object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the infraprotect ASN prefix review status is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"review_type_approved": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_pending": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_rejected": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"review_type": [
"review_type_approved",
"review_type_pending",
"review_type_rejected"
]
}
}
]
},
	"infraprotect-update-asn-review-status": {
"name": "infraprotect-update-asn-review-status",
"displayName": "Infraprotect Update Asn Review Status",
"operations": [
{
"name": "create_infraprotect_update_asn_review_statu",
"description": "Update ASN Review Status.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_asns/update-asn-review-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update infraprotect ASN review status.",
"title": "Update Infraprotect ASN Review Status",
"x-displayname": "Update Infraprotect ASN Review Status Request.",
"x-ves-oneof-field-review_type": "[\"review_type_approved\",\"review_type_pending\",\"review_type_rejected\"]",
"x-ves-proto-message": "ves.io.schema.infraprotect_asn.UpdateASNReviewStatusRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the infraprotect ASN object to be updated.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the infraprotect ASN object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the infraprotect ASN review status is to be updated.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the infraprotect ASN review status is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"review_type_approved": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for review type approved.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_pending": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for review type pending.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_rejected": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for review type rejected.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to update infraprotect ASN review status.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_asnUpdateASNReviewStatusRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_asnUpdateASNReviewStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for infraprotect_asnUpdateASNReviewStatusRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the infraprotect ASN object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the infraprotect ASN review status is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"review_type_approved": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_pending": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"review_type_rejected": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"review_type": [
"review_type_approved",
"review_type_pending",
"review_type_rejected"
]
}
}
]
},
	"infraprotect-update-tunnel-clear-df-bit": {
"name": "infraprotect-update-tunnel-clear-df-bit",
"displayName": "Infraprotect Update Tunnel Clear Df Bit",
"operations": [
{
"name": "create_infraprotect_update_tunnel_clear_df_bit",
"description": "Update Tunnel Clear DF Bit.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels/update-tunnel-clear-df-bit",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update tunnel lear DF bit.",
"title": "Update Tunnel Clear DF Bit",
"x-displayname": "Update Tunnel Clear DF Bit Request.",
"x-ves-oneof-field-clear_df_bit": "[\"clear_df_bit_disabled\",\"clear_df_bit_enabled\"]",
"x-ves-proto-message": "ves.io.schema.infraprotect_tunnel.UpdateTunnelClearDFBitRequest",
"properties": {
"clear_df_bit_disabled": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"clear_df_bit_enabled": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the tunnel clear df bit is to be updated.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the tunnel clear df bit is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"tunnel_id": {
"type": "string",
"description": "Unique identifier of the tunnel to update.",
"title": "Tunnel identifier",
"x-displayname": "Tunnel ID",
"x-ves-example": "F5XC-ASH-T-000004.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "F5XC-ASH-T-000004",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Unique identifier of the tunnel to update.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_tunnelUpdateTunnelClearDFBitRequest",
"required_fields": [
"namespace",
"tunnel_id"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_tunnelUpdateTunnelClearDFBitRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  tunnel_id: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"tunnel_id\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"tunnel_id": "value"
}
},
"requiredFields": [
"namespace",
"tunnel_id"
],
"description": "Minimum configuration for infraprotect_tunnelUpdateTunnelClearDFBitRequest"
},
"fieldMetadata": {
"clear_df_bit_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"clear_df_bit_enabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the tunnel clear df bit is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tunnel_id": {
"type": "string",
"description": "Unique identifier of the tunnel to update.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"clear_df_bit": [
"clear_df_bit_disabled",
"clear_df_bit_enabled"
]
}
}
]
},
	"infraprotect-update-tunnel-status": {
"name": "infraprotect-update-tunnel-status",
"displayName": "Infraprotect Update Tunnel Status",
"operations": [
{
"name": "create_infraprotect_update_tunnel_statu",
"description": "Update Tunnel Status.",
"method": "POST",
"path": "/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels/update-tunnel-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update tunnel status.",
"title": "Update Tunnel Status",
"x-displayname": "Update Tunnel Status Request.",
"x-ves-proto-message": "ves.io.schema.infraprotect_tunnel.UpdateTunnelStatusRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace in which the tunnel status is to be updated.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the tunnel status is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"tunnel_id": {
"type": "string",
"description": "Unique identifier of the tunnel to update.",
"title": "Tunnel identifier",
"x-displayname": "Tunnel ID",
"x-ves-example": "F5XC-ASH-T-000004.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "F5XC-ASH-T-000004",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Unique identifier of the tunnel to update.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"tunnel_status": {
"allOf": [
{
"$ref": "#/components/schemas/infraprotect_tunnelTunnelStatus"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotect_tunnelUpdateTunnelStatusRequest",
"required_fields": [
"namespace",
"tunnel_id"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotect_tunnelUpdateTunnelStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  tunnel_id: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"tunnel_id\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"tunnel_id": "value"
}
},
"requiredFields": [
"namespace",
"tunnel_id"
],
"description": "Minimum configuration for infraprotect_tunnelUpdateTunnelStatusRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace in which the tunnel status is to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tunnel_id": {
"type": "string",
"description": "Unique identifier of the tunnel to update.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tunnel_status": {
"type": "string",
"description": "Current status of the tunnel.\n\nInactive config status\nDown config status\nActive config status\nActivation Pending config status\nActivation Error - Needs Attention\nActivation Initializing.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TUNNEL_STATUS_INACTIVE"
}
}
}
]
},
	"interface": {
"name": "interface",
"displayName": "Interface",
"operations": [
{
"name": "list_interface",
"description": "Interface List.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sites/{site}/interface",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"interface": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "interface",
"type": "array",
"description": "List of the interface connected to site."
}
]
}
]
},
	"invoice-pdf": {
"name": "invoice-pdf",
"displayName": "Invoice Pdf",
"operations": [
{
"name": "list_invoice_pdf",
"description": "GetInvoicePdf.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/usage/invoice_pdf",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"pdf": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "pdf",
"type": "string",
"description": "Base 64 encoded invoice as a PDF document."
}
]
}
]
},
	"invoices-custom-list": {
"name": "invoices-custom-list",
"displayName": "Invoices Custom List",
"operations": [
{
"name": "list_invoices_custom_list",
"description": "List invoices.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/usage/invoices/custom_list",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"invoices": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "invoices",
"type": "array",
"description": "List of invoices as per customer request."
}
]
}
]
},
	"ip-prefix-sets": {
"name": "ip-prefix-sets",
"displayName": "Ip Prefix Sets",
"operations": [
{
"name": "create_ip_prefix_set",
"description": "Create IP Prefix Set.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/ip_prefix_sets",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of ip_prefix_set",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.ip_prefix_set.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/ip_prefix_setCreateSpecType"
}
],
"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 ip_prefix_setCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ip_prefix_setCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ip_prefix_setCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create ip_prefix_set creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipv4_prefixes": {
"type": "array",
"description": "List of IPv4 prefixes with description.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1024,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_ip_prefix_set",
"description": "Replace IP Prefix Set.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/ip_prefix_sets/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a ip_prefix_set",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.ip_prefix_set.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/ip_prefix_setReplaceSpecType"
}
],
"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 ip_prefix_setReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ip_prefix_setReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ip_prefix_setReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace ip_prefix_set replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ipv4_prefixes": {
"type": "array",
"description": "List of IPv4 prefixes with description.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1024,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_ip_prefix_sets",
"description": "List IP Prefix Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ip_prefix_sets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_ip_prefix_set",
"description": "DELETE IP Prefix Set.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/ip_prefix_sets/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a ip_prefix_set",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.ip_prefix_set.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ip_prefix_setDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ip_prefix_setDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_ip_prefix_set",
"description": "GET IP Prefix Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/ip_prefix_sets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"irules": {
"name": "irules",
"displayName": "Irules",
"operations": [
{
"name": "create_irule",
"description": "Create iRule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/irules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of irule",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.irule.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/iruleCreateSpecType"
}
],
"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 iruleCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for iruleCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for iruleCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create iRule in a given namespace. If one already exists it will give an error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.description": {
"type": "string",
"description": "Specify Description for iRule.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.irule": {
"type": "string",
"description": "www.internal.example.f5.com\")} DNS::drop}\nirule content.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 24576,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_irule",
"description": "Replace iRule.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/irules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a irule",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.irule.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/iruleReplaceSpecType"
}
],
"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 iruleReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for iruleReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for iruleReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace iRule in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.description": {
"type": "string",
"description": "Specify Description for iRule.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.irule": {
"type": "string",
"description": "www.internal.example.f5.com\")} DNS::drop}\nirule content.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 24576,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_irules",
"description": "List Configure iRule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/irules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_irule",
"description": "DELETE Configure iRule.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/irules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a irule",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.bigcne.irule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for iruleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for iruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bigip"
}
},
{
"name": "get_irule",
"description": "GET iRule",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/irules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"k8s-audit-logs": {
"name": "k8s-audit-logs",
"displayName": "K8S Audit Logs",
"operations": [
{
"name": "create_k8s_audit_log",
"description": "K8s Audit Log Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch K8s audit logs.",
"title": "K8SAuditLogRequest",
"x-displayname": "K8s Audit Log Request.",
"x-ves-proto-message": "ves.io.schema.log.K8SAuditLogRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch K8s audit logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch K8s audit logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={objectref.resource=\"deployments\"}",
"x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "CE-1",
"x-f5xc-example": "ce-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logK8SAuditLogRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logK8SAuditLogRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logK8SAuditLogRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch K8s audit logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"k8s-audit-logs-aggregation": {
"name": "k8s-audit-logs-aggregation",
"displayName": "K8S Audit Logs Aggregation",
"operations": [
{
"name": "create_k8s_audit_logs_aggregation",
"description": "K8s Audit Log Aggregation Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for K8s audit logs.",
"title": "K8SAuditLogAggregationRequest",
"x-displayname": "K8s Audit Log Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.log.K8SAuditLogAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={objectref.resource=\"deployments\"}",
"x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "CE-1",
"x-f5xc-example": "ce-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for K8s audit logs.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logK8SAuditLogAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logK8SAuditLogAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logK8SAuditLogAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"k8s-cluster-role-bindings": {
"name": "k8s-cluster-role-bindings",
"displayName": "K8S Cluster Role Bindings",
"operations": [
{
"name": "create_k8s_cluster_role_binding",
"description": "Create Configuration Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of k8s_cluster_role_binding",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster_role_binding.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/k8s_cluster_role_bindingCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Kubernetes cluster configuration for F5 XC managed K8s",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-k8s-cluster\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-k8s-cluster\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-k8s-cluster",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Kubernetes cluster configuration for F5 XC managed K8s"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create k8s_cluster_role_binding will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.subjects": {
"type": "array",
"description": "List of subjects (user, group or service account) to which this role is bound.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_k8s_cluster_role_binding",
"description": "Replace Configuration Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a k8s_cluster_role_binding",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster_role_binding.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/k8s_cluster_role_bindingReplaceSpecType"
}
],
"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": "Kubernetes cluster configuration for F5 XC managed K8s",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-k8s-cluster\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-k8s-cluster\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-k8s-cluster",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Kubernetes cluster configuration for F5 XC managed K8s"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an k8s_cluster_role_binding object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.subjects": {
"type": "array",
"description": "List of subjects (user, group or service account) to which this role is bound.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_k8s_cluster_role_bindings",
"description": "List K8s Cluster Role Binding.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_k8s_cluster_role_binding",
"description": "DELETE K8s Cluster Role Binding.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a k8s_cluster_role_binding",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster_role_binding.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_cluster_role_bindingDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_cluster_role_bindingDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
}
},
{
"name": "get_k8s_cluster_role_binding",
"description": "GET Configuration Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"k8s-cluster-roles": {
"name": "k8s-cluster-roles",
"displayName": "K8S Cluster Roles",
"operations": [
{
"name": "create_k8s_cluster_role",
"description": "Create Configuration Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_roles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of k8s_cluster_role",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster_role.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/k8s_cluster_roleCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Kubernetes cluster configuration for F5 XC managed K8s",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-k8s-cluster\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-k8s-cluster\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-k8s-cluster",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Kubernetes cluster configuration for F5 XC managed K8s"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create k8s_cluster_role will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policy_rule_list": {
"type": "object",
"description": "List of rules for role permissions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_rule_list.policy_rule": {
"type": "array",
"description": "List of rules for role permissions.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.yaml": {
"type": "string",
"description": "Exclusive with [k8s_cluster_role_selector policy_rule_list]\nK8s YAML for ClusterRole.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 4096,
"minLength": 1,
"formatDescription": "Valid parseable YAML",
"validation": {
"customRule": "Must be valid YAML"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"format": "uri"
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.rule_choice": [
"k8s_cluster_role_selector",
"policy_rule_list",
"yaml"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_k8s_cluster_role",
"description": "Replace Configuration Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_roles/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a k8s_cluster_role",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster_role.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/k8s_cluster_roleReplaceSpecType"
}
],
"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": "Kubernetes cluster configuration for F5 XC managed K8s",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-k8s-cluster\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-k8s-cluster\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-k8s-cluster",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Kubernetes cluster configuration for F5 XC managed K8s"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an k8s_cluster_role object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster_role_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policy_rule_list": {
"type": "object",
"description": "List of rules for role permissions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.policy_rule_list.policy_rule": {
"type": "array",
"description": "List of rules for role permissions.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.yaml": {
"type": "string",
"description": "Exclusive with [k8s_cluster_role_selector policy_rule_list]\nK8s YAML for ClusterRole.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 4096,
"minLength": 1,
"formatDescription": "Valid parseable YAML",
"validation": {
"customRule": "Must be valid YAML"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"format": "uri"
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.rule_choice": [
"k8s_cluster_role_selector",
"policy_rule_list",
"yaml"
]
}
},
{
"name": "list_k8s_cluster_roles",
"description": "List K8s Cluster Role.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_roles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_k8s_cluster_role",
"description": "DELETE K8s Cluster Role.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_roles/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a k8s_cluster_role",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster_role.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_cluster_roleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_cluster_roleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
}
},
{
"name": "get_k8s_cluster_role",
"description": "GET Configuration Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_cluster_roles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"k8s-clusters": {
"name": "k8s-clusters",
"displayName": "K8S Clusters",
"operations": [
{
"name": "create_k8s_cluster",
"description": "Create Configuration Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/k8s_clusters",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of k8s_cluster",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster.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/k8s_clusterCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Kubernetes cluster configuration for F5 XC managed K8s",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-k8s-cluster\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-k8s-cluster\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-k8s-cluster",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Kubernetes cluster configuration for F5 XC managed K8s"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create k8s_cluster will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_scoped_access_deny": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_scoped_access_permit": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_wide_app_list": {
"type": "object",
"description": "List of cluster wide applications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_wide_app_list.cluster_wide_apps": {
"type": "array",
"description": "List of cluster wide applications.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.global_access_enable": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.insecure_registry_list": {
"type": "object",
"description": "List of docker insecure registries.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.insecure_registry_list.insecure_registries": {
"type": "array",
"description": "List of docker insecure registries in format \"example.com:5000\"",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.local_access_config": {
      "type": "object",
"description": "Parameters required to enable local access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_access_config.default_port": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_access_config.local_domain": {
      "type": "string",
"description": "Local K8s API server will be accessible at <site name>.<local domain>.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 192,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.local_access_config.port": {
      "type": "integer",
"description": "Exclusive with [default_port]\nUse custom K8s port for API server.\nAvailable port range is less than 65000 except reserved ports.",
      "constraints": {
"constraintType": "number",
"category": "networking",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_cluster_wide_apps": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_global_access": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_insecure_registries": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_local_access": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_bindings": {
"type": "object",
"description": "List of active cluster role binding list for a K8s cluster.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_bindings.cluster_role_bindings": {
"type": "array",
"description": "List of active cluster role binding list for a K8s cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_list": {
"type": "object",
"description": "List of active cluster role list for a K8s cluster.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_list.cluster_roles": {
"type": "array",
"description": "List of active cluster role list for a K8s cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_psp_list": {
"type": "object",
"description": "List of active Pod security policies for a K8s cluster.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_psp_list.pod_security_policies": {
"type": "array",
"description": "List of active Pod security policies for a K8s cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_cluster_role_bindings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_cluster_roles": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_pod_security_admission": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_psp": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vk8s_namespace_access_deny": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vk8s_namespace_access_permit": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.apps_choice": [
"cluster_wide_app_list",
"no_cluster_wide_apps"
],
"spec.cluster_role_bindings_choice": [
"use_custom_cluster_role_bindings",
"use_default_cluster_role_bindings"
],
"spec.cluster_role_choice": [
"use_custom_cluster_role_list",
"use_default_cluster_roles"
],
"spec.cluster_scoped_resource_access_choice": [
      "cluster_scoped_access_deny",
      "cluster_scoped_access_permit"
      ],
"spec.global_access_choice": [
      "global_access_enable",
      "no_global_access"
      ],
"spec.insecure_registries_choice": [
"insecure_registry_list",
"no_insecure_registries"
],
"spec.local_access_choice": [
      "local_access_config",
      "no_local_access"
      ],
"spec.pod_security_admission_choice": [
"use_custom_pod_security_admission",
"use_default_pod_security_admission"
],
"spec.pod_security_policy_choice": [
"use_custom_psp_list",
"use_default_psp"
],
"spec.vk8s_namespace_access_choice": [
      "vk8s_namespace_access_deny",
      "vk8s_namespace_access_permit"
      ],
"spec.local_access_config.port_choice": [
      "default_port",
"port"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_k8s_cluster",
"description": "Replace Configuration Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/k8s_clusters/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a k8s_cluster",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/k8s_clusterReplaceSpecType"
}
],
"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": "Kubernetes cluster configuration for F5 XC managed K8s",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-k8s-cluster\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-k8s-cluster\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-k8s-cluster",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Kubernetes cluster configuration for F5 XC managed K8s"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an k8s_cluster object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_scoped_access_deny": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_scoped_access_permit": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_wide_app_list": {
"type": "object",
"description": "List of cluster wide applications.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cluster_wide_app_list.cluster_wide_apps": {
"type": "array",
"description": "List of cluster wide applications.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.global_access_enable": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.insecure_registry_list": {
"type": "object",
"description": "List of docker insecure registries.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.insecure_registry_list.insecure_registries": {
"type": "array",
"description": "List of docker insecure registries in format \"example.com:5000\"",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.local_access_config": {
      "type": "object",
"description": "Parameters required to enable local access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_access_config.default_port": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_access_config.local_domain": {
      "type": "string",
"description": "Local K8s API server will be accessible at <site name>.<local domain>.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 192,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.local_access_config.port": {
      "type": "integer",
"description": "Exclusive with [default_port]\nUse custom K8s port for API server.\nAvailable port range is less than 65000 except reserved ports.",
      "constraints": {
"constraintType": "number",
"category": "networking",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_cluster_wide_apps": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_global_access": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_insecure_registries": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_local_access": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_bindings": {
"type": "object",
"description": "List of active cluster role binding list for a K8s cluster.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_bindings.cluster_role_bindings": {
"type": "array",
"description": "List of active cluster role binding list for a K8s cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_list": {
"type": "object",
"description": "List of active cluster role list for a K8s cluster.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_cluster_role_list.cluster_roles": {
"type": "array",
"description": "List of active cluster role list for a K8s cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_pod_security_admission.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_psp_list": {
"type": "object",
"description": "List of active Pod security policies for a K8s cluster.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_custom_psp_list.pod_security_policies": {
"type": "array",
"description": "List of active Pod security policies for a K8s cluster.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.use_default_cluster_role_bindings": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_cluster_roles": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_pod_security_admission": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_default_psp": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vk8s_namespace_access_deny": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vk8s_namespace_access_permit": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.apps_choice": [
"cluster_wide_app_list",
"no_cluster_wide_apps"
],
"spec.cluster_role_bindings_choice": [
"use_custom_cluster_role_bindings",
"use_default_cluster_role_bindings"
],
"spec.cluster_role_choice": [
"use_custom_cluster_role_list",
"use_default_cluster_roles"
],
"spec.cluster_scoped_resource_access_choice": [
      "cluster_scoped_access_deny",
      "cluster_scoped_access_permit"
      ],
"spec.global_access_choice": [
      "global_access_enable",
      "no_global_access"
      ],
"spec.insecure_registries_choice": [
"insecure_registry_list",
"no_insecure_registries"
],
"spec.local_access_choice": [
      "local_access_config",
      "no_local_access"
      ],
"spec.pod_security_admission_choice": [
"use_custom_pod_security_admission",
"use_default_pod_security_admission"
],
"spec.pod_security_policy_choice": [
"use_custom_psp_list",
"use_default_psp"
],
"spec.vk8s_namespace_access_choice": [
      "vk8s_namespace_access_deny",
      "vk8s_namespace_access_permit"
      ],
"spec.local_access_config.port_choice": [
      "default_port",
"port"
]
}
},
{
"name": "list_k8s_clusters",
"description": "List K8s Cluster.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_clusters",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_k8s_cluster",
"description": "DELETE K8s Cluster.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/k8s_clusters/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a k8s_cluster",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.k8s_cluster.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_clusterDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_clusterDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
}
},
{
"name": "get_k8s_cluster",
"description": "GET Configuration Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_clusters/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"k8s-events": {
"name": "k8s-events",
"displayName": "K8S Events",
"operations": [
{
"name": "create_k8s_event",
"description": "K8s Events Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/site/{site}/k8s_events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch physical K8s events.",
"title": "K8s Events Request",
"x-displayname": "K8s Events Request.",
"x-ves-proto-message": "ves.io.schema.log.K8SEventsRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of K8s events returned in the response\nOptional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of K8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of K8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch K8s events for the given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch K8s events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\nsite - Name of the site\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the K8s events for the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={involvedobject.kind=\"Pod\"}",
"x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of events (or all events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of events until there are no more events left to return. The number of events in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of events (or all events) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of events (or all events) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of events until there are no more events left to return. The number of events in each batch is...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "CE-1",
"x-f5xc-example": "ce-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logK8SEventsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logK8SEventsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logK8SEventsRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of K8s events returned in the response\nOptional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch K8s events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\nsite - Name of the site\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the K8s events for the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of events (or all events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of events until there are no more events left to return. The number of events in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"k8s-events-aggregation": {
"name": "k8s-events-aggregation",
"displayName": "K8S Events Aggregation",
"operations": [
{
"name": "create_k8s_events_aggregation",
"description": "K8s Events Aggregation Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/site/{site}/k8s_events/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for K8s events in a Cluster.",
"title": "K8s Events Aggregation Request",
"x-displayname": "K8s Events Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.log.K8SEventsAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the K8s events for the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={involvedobject.kind=\"Pod\"}",
"x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "CE-1",
"x-f5xc-example": "ce-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for K8s events in a Cluster.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logK8SEventsAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logK8SEventsAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logK8SEventsAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "GET aggregation data for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the K8s events for the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site where the K8s Cluster is running.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"k8s-pod-security-admissions": {
"name": "k8s-pod-security-admissions",
"displayName": "K8S Pod Security Admissions",
"operations": [
{
"name": "create_k8s_pod_security_admission",
"description": "Create Configuration Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_admissions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of k8s_pod_security_admission",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.k8s_pod_security_admission.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/k8s_pod_security_admissionCreateSpecType"
}
],
"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 k8s_pod_security_admissionCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_pod_security_admissionCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for k8s_pod_security_admissionCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create k8s_pod_security_admission will create the object in the storage backend.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pod_security_admission_specs": {
"type": "array",
"description": "Uniform Resource Identifier",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 9,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_k8s_pod_security_admission",
"description": "Replace Configuration Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_admissions/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a k8s_pod_security_admission",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.k8s_pod_security_admission.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/k8s_pod_security_admissionReplaceSpecType"
}
],
"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 k8s_pod_security_admissionReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_pod_security_admissionReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for k8s_pod_security_admissionReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an k8s_pod_security_admission object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pod_security_admission_specs": {
"type": "array",
"description": "Uniform Resource Identifier",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 9,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_k8s_pod_security_admissions",
"description": "List K8s Pod Security Admission.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_admissions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_k8s_pod_security_admission",
"description": "DELETE K8s Pod Security Admission.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_admissions/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a k8s_pod_security_admission",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.k8s_pod_security_admission.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_pod_security_admissionDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_pod_security_admissionDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
}
},
{
"name": "get_k8s_pod_security_admission",
"description": "GET Configuration Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_admissions/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"k8s-pod-security-policys": {
"name": "k8s-pod-security-policys",
"displayName": "K8S Pod Security Policys",
"operations": [
{
"name": "create_k8s_pod_security_policy",
"description": "Create Configuration Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of k8s_pod_security_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.k8s_pod_security_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/k8s_pod_security_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_pod_security_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_pod_security_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for k8s_pod_security_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec": {
"type": "object",
"description": "Form based pod security specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allow_privilege_escalation": {
"type": "boolean",
"description": "Pod can request to privilege escalation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_capabilities": {
"type": "object",
"description": "List of capabilities that docker container has.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_csi_drivers": {
"type": "array",
"description": "Restrict the available CSI drivers for POD, default all drivers are available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_flex_volumes": {
"type": "array",
"description": "Restrict list of Flex volumes, default all volumes are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_host_paths": {
"type": "array",
"description": "Restrict list of host paths, default all host paths are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_proc_mounts": {
"type": "array",
"description": "Allowed list of proc mounts, empty list allows default proc mounts.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_unsafe_sysctls": {
"type": "array",
"description": "Allowed list of unsafe sysctls, empty list allows none. Supports prefix reg-ex.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.default_allow_privilege_escalation": {
"type": "boolean",
"description": "Pod has permission for privilege escalation by default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.default_capabilities": {
"type": "object",
"description": "List of capabilities that docker container has.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.drop_capabilities": {
"type": "object",
"description": "List of capabilities that docker container has.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.forbidden_sysctls": {
"type": "array",
"description": "Forbidden list of sysctls, empty list forbids none. Supports prefix reg-ex.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.fs_group_strategy_options": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_ipc": {
"type": "boolean",
"description": "Host IPC determines if the policy allows the use of host IPC in the pod spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_network": {
"type": "boolean",
"description": "Host Network determines if the policy allows the use of host network in the pod spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_pid": {
"type": "boolean",
"description": "Host PID determines if the policy allows the use of host PID in the pod spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_port_ranges": {
"type": "string",
"description": "Host port ranges determines which ports ranges are allowed to be exposed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_allowed_capabilities": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_default_capabilities": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_drop_capabilities": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_fs_groups": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_run_as_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_run_as_user": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_runtime_class": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_se_linux_options": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_supplemental_groups": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.privileged": {
"type": "boolean",
"description": "Privileged determines if a pod can request to be run as privileged.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.read_only_root_filesystem": {
"type": "boolean",
"description": "Containers can only run with read only root filesystem.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.run_as_group": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.run_as_user": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.supplemental_groups": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.volumes": {
"type": "array",
"description": "Allow List of volume plugins. Empty no volumes are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.yaml": {
"type": "string",
"description": "Exclusive with [psp_spec]\nK8s YAML for Pod Security Policy.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 4096,
"minLength": 1,
"formatDescription": "Valid parseable YAML",
"validation": {
"customRule": "Must be valid YAML"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"format": "uri"
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.config_method_choice": [
"psp_spec",
"yaml"
],
"spec.psp_spec.allowed_capabilities_choice": [
"allowed_capabilities",
"no_allowed_capabilities"
],
"spec.psp_spec.default_capabilities_choice": [
"default_capabilities",
"no_default_capabilities"
],
"spec.psp_spec.drop_capabilities_choice": [
"drop_capabilities",
"no_drop_capabilities"
],
"spec.psp_spec.fs_group_choice": [
"fs_group_strategy_options",
"no_fs_groups"
],
"spec.psp_spec.group_choice": [
"no_run_as_group",
"run_as_group"
],
"spec.psp_spec.runtime_class_choice": [
"no_runtime_class"
],
"spec.psp_spec.se_linux_choice": [
"no_se_linux_options"
],
"spec.psp_spec.supplemental_group_choice": [
"no_supplemental_groups",
"supplemental_groups"
],
"spec.psp_spec.user_choice": [
"no_run_as_user",
"run_as_user"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_k8s_pod_security_policy",
"description": "Replace Configuration Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a k8s_pod_security_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.k8s_pod_security_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/k8s_pod_security_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_pod_security_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_pod_security_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for k8s_pod_security_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an k8s_pod_security_policy object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec": {
"type": "object",
"description": "Form based pod security specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allow_privilege_escalation": {
"type": "boolean",
"description": "Pod can request to privilege escalation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_capabilities": {
"type": "object",
"description": "List of capabilities that docker container has.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_csi_drivers": {
"type": "array",
"description": "Restrict the available CSI drivers for POD, default all drivers are available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_flex_volumes": {
"type": "array",
"description": "Restrict list of Flex volumes, default all volumes are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_host_paths": {
"type": "array",
"description": "Restrict list of host paths, default all host paths are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_proc_mounts": {
"type": "array",
"description": "Allowed list of proc mounts, empty list allows default proc mounts.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.allowed_unsafe_sysctls": {
"type": "array",
"description": "Allowed list of unsafe sysctls, empty list allows none. Supports prefix reg-ex.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.default_allow_privilege_escalation": {
"type": "boolean",
"description": "Pod has permission for privilege escalation by default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.default_capabilities": {
"type": "object",
"description": "List of capabilities that docker container has.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.drop_capabilities": {
"type": "object",
"description": "List of capabilities that docker container has.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.forbidden_sysctls": {
"type": "array",
"description": "Forbidden list of sysctls, empty list forbids none. Supports prefix reg-ex.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.fs_group_strategy_options": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_ipc": {
"type": "boolean",
"description": "Host IPC determines if the policy allows the use of host IPC in the pod spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_network": {
"type": "boolean",
"description": "Host Network determines if the policy allows the use of host network in the pod spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_pid": {
"type": "boolean",
"description": "Host PID determines if the policy allows the use of host PID in the pod spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.host_port_ranges": {
"type": "string",
"description": "Host port ranges determines which ports ranges are allowed to be exposed.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_allowed_capabilities": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_default_capabilities": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_drop_capabilities": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_fs_groups": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_run_as_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_run_as_user": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_runtime_class": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_se_linux_options": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.no_supplemental_groups": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.privileged": {
"type": "boolean",
"description": "Privileged determines if a pod can request to be run as privileged.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.read_only_root_filesystem": {
"type": "boolean",
"description": "Containers can only run with read only root filesystem.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.run_as_group": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.run_as_user": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.supplemental_groups": {
"type": "object",
"description": "ID ranges and rules.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.psp_spec.volumes": {
"type": "array",
"description": "Allow List of volume plugins. Empty no volumes are allowed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.yaml": {
"type": "string",
"description": "Exclusive with [psp_spec]\nK8s YAML for Pod Security Policy.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 4096,
"minLength": 1,
"formatDescription": "Valid parseable YAML",
"validation": {
"customRule": "Must be valid YAML"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"format": "uri"
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.config_method_choice": [
"psp_spec",
"yaml"
],
"spec.psp_spec.allowed_capabilities_choice": [
"allowed_capabilities",
"no_allowed_capabilities"
],
"spec.psp_spec.default_capabilities_choice": [
"default_capabilities",
"no_default_capabilities"
],
"spec.psp_spec.drop_capabilities_choice": [
"drop_capabilities",
"no_drop_capabilities"
],
"spec.psp_spec.fs_group_choice": [
"fs_group_strategy_options",
"no_fs_groups"
],
"spec.psp_spec.group_choice": [
"no_run_as_group",
"run_as_group"
],
"spec.psp_spec.runtime_class_choice": [
"no_runtime_class"
],
"spec.psp_spec.se_linux_choice": [
"no_se_linux_options"
],
"spec.psp_spec.supplemental_group_choice": [
"no_supplemental_groups",
"supplemental_groups"
],
"spec.psp_spec.user_choice": [
"no_run_as_user",
"run_as_user"
]
}
},
{
"name": "list_k8s_pod_security_policys",
"description": "List K8s Pod Security Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_k8s_pod_security_policy",
"description": "DELETE K8s Pod Security Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a k8s_pod_security_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.k8s_pod_security_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for k8s_pod_security_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for k8s_pod_security_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "managed_kubernetes"
}
},
{
"name": "get_k8s_pod_security_policy",
"description": "GET Configuration Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/k8s_pod_security_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"known-label-keys": {
"name": "known-label-keys",
      "displayName": "Known Label Keys",
      "operations": [
{
"name": "list_known_label_keys",
      "description": "GET",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/known_label_keys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "query",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "key",
      "in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"label_key": {
      "type": "array"
}
}
},
"responseSummary": [
{
"field": "label_key",
      "type": "array",
"description": "Label Key"
      }
]
}
]
},
	"known-labels": {
"name": "known-labels",
"displayName": "Known Labels",
"operations": [
{
"name": "list_known_labels",
"description": "GET",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/known_labels",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "query",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "key",
      "in": "query",
"required": false,
"type": "string"
},
{
"name": "value",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"label": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "label",
"type": "array",
"description": "Label Type."
}
]
}
]
},
	"l7ddos-rps-threshold": {
"name": "l7ddos-rps-threshold",
"displayName": "L7Ddos Rps Threshold",
"operations": [
{
"name": "create_l7ddos_rps_threshold",
"description": "Set L7 DDoS RPS Threshold.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/l7ddos_rps_threshold",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to set L7 DDoS RPS Threshold.",
"title": "Set L7 DDoS RPS Threshold Request",
"x-displayname": "Set L7 DDoS RPS Threshold Request.",
"x-ves-proto-message": "ves.io.schema.views.http_loadbalancer.SetL7DDoSRPSThresholdReq",
"properties": {
"name": {
"type": "string",
"description": "Name of the HTTP loadbalancer.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Lb_name",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "lb_name",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace scope of the request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"rps_threshold": {
"type": "integer",
"description": "The new RPS threshold to set.",
"title": "RPS Threshold",
"format": "int64",
"x-displayname": "RPS Threshold.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "20000"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "20000"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 20000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for http_loadbalancerSetL7DDoSRPSThresholdReq",
"required_fields": [
"name",
"namespace",
"rps_threshold"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for http_loadbalancerSetL7DDoSRPSThresholdReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  rps_threshold: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"rps_threshold\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"rps_threshold": "value"
}
},
"requiredFields": [
"name",
"namespace",
"rps_threshold"
],
"description": "Minimum configuration for http_loadbalancerSetL7DDoSRPSThresholdReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the HTTP loadbalancer.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace scope of the request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"rps_threshold": {
"type": "integer",
"description": "The new RPS threshold to set.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 20000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"latency": {
"name": "latency",
"displayName": "Latency",
"operations": [
{
"name": "create_latency",
"description": "Service Policy Latency.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/service_policy/latency",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the Service policy hits counter.",
"title": "Service Policy Hits Request",
"x-displayname": "Service Policy Hits Request.",
"x-ves-proto-message": "ves.io.schema.service_policy.ServicePolicyHitsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels specified in `group_by`.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by `POLICY`.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/service_policyServicePolicyMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one of more labels specified in . Optional: If not specified, then the rule hits are aggregated/grouped by .",
"x-f5xc-description-medium": "Aggregate data by one of more labels specified in . Optional: If not specified, then the rule hits are aggregated/grouped by .",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" `Op` \"value\".\nResponse will only contain data that matches all the conditions specified in the `label_filter`.\n\nOptional: If not specified, then the metrics will be filtered only based on the `namespace` in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/service_policyServicePolicyMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" \"value\". Response will only contain data that matches all the conditions specified in the .",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" \"value\". Response will only contain data that matches all the conditions specified in the . Optional: If not specified, then the metrics will be filtered only based on the in the request.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope Service policy hits for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace is used to scope Service policy hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the Service policy hits counter.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for service_policyServicePolicyHitsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for service_policyServicePolicyHitsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for service_policyServicePolicyHitsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels specified in `group_by`.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by `POLICY`.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" `Op` \"value\".\nResponse will only contain data that matches all the conditions specified in the `label_filter`.\n\nOptional: If not specified, then the metrics will be filtered only based on the `namespace` in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope Service policy hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of Service policy hits data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"lb-cache-content": {
"name": "lb-cache-content",
"displayName": "Lb Cache Content",
"operations": [
{
"name": "create_lb_cache_content",
"description": "Cacheability query Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/lb_cache_content",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Graph/cacheable_content API is used to GET data for CDN services.",
      "title": "Cacheable Content Request",
"x-displayname": "Cacheable Content Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.LBCacheContentRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOptional: If not specified, only the following fields are returned in the response.\nREQUEST_RATE, RESPONSE_THROUGHPUT.",
"title": "Field Selector",
"items": {
"$ref": "#/components/schemas/schemagraphMetricType"
},
"x-displayname": "Field Selector.",
"x-ves-validation-rules": {
"ves.io.schema.rules.enum.in": "[1,5]"
},
"x-validation-rules": {
"ves.io.schema.rules.enum.in": "[1,5]"
},
"x-f5xc-description-short": "Select fields to be returned in the response. Optional: If not specified, only the following fields are returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. Optional: If not specified, only the following fields are returned in the response. REQUEST_RATE, RESPONSE_THROUGHPUT.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of namespace, cacheability, vhost.\n\nOptional: If not specified, then the data is aggregated/grouped by vh_name.",
"title": "Group by",
"maxItems": 4,
"items": {
"$ref": "#/components/schemas/serviceIdField"
},
"x-displayname": "Group By",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "4",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "4",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Aggregate data by any or all of namespace, cacheability, vhost. Optional: If not specified, then the data is aggregated/grouped by vh_name.",
"x-f5xc-description-medium": "Aggregate data by any or all of namespace, cacheability, vhost. Optional: If not specified, then the data is aggregated/grouped by vh_name.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nFor cacheable content, user should specify LABEL_VHOST_CACHE & LABEL_VHOST in the label_filter.",
      "title": "Label Filter",
"minItems": 1,
"maxItems": 16,
"items": {
"$ref": "#/components/schemas/serviceLabelFilter"
},
"x-displayname": "Label Filter.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "16",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "16",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. For cacheable content, user should specify LABEL_VHOST_CACHE & LABEL_VHOST in the label_filter.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope load balancers. Only LB's in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope load balancers. Only LB's in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Graph/cacheable_content API is used to GET data for CDN services.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceLBCacheContentRequest",
"required_fields": [
"label_filter"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceLBCacheContentRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  label_filter: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"label_filter\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"label_filter": "value"
}
},
"requiredFields": [
"label_filter"
],
"description": "Minimum configuration for serviceLBCacheContentRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOptional: If not specified, only the following fields are returned in the response.\nREQUEST_RATE, RESPONSE_THROUGHPUT.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of namespace, cacheability, vhost.\n\nOptional: If not specified, then the data is aggregated/grouped by vh_name.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nFor cacheable content, user should specify LABEL_VHOST_CACHE & LABEL_VHOST in the label_filter.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope load balancers. Only LB's in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "nodes",
"type": "array",
"description": "List of LB's in requested for Cacheable Content Data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"limits": {
"name": "limits",
"displayName": "Limits",
"operations": [
{
"name": "list_limits",
"description": "Custom GET Quota Limits.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/quota/limits",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"api_limits": {
      "type": "object"
},
"apis": {
      "type": "object"
},
"float_quota_usage": {
"type": "object"
},
"objects": {
"type": "object"
},
"quota_usage": {
"type": "object"
},
"resources": {
"type": "object"
}
}
},
"responseSummary": [
{
"field": "api_limits",
      "type": "object",
"description": "APILimits object.\nDeprecated by 'APIs'"
      },
{
"field": "apis",
      "type": "object",
"description": "Configured rate limits for APIs."
      },
{
"field": "float_quota_usage",
"type": "object",
"description": "FloatQuotaUsage object.\nDeprecated by 'resources'"
},
{
"field": "objects",
"type": "object",
"description": "Configured limits for object instances."
},
{
"field": "quota_usage",
"type": "object",
"description": "QuotaUsage object.\nDeprecated by 'objects'"
},
{
"field": "resources",
"type": "object",
"description": "Configured limits for resources if relevant."
}
]
}
]
},
	"lma-regions": {
"name": "lma-regions",
"displayName": "Lma Regions",
"operations": [
{
"name": "list_lma_regions",
"description": "List LMA Region.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/lma_regions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_lma_region",
"description": "GET LMA Region.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/lma_regions/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"loadbalancers": {
"name": "loadbalancers",
"displayName": "Loadbalancers",
"operations": [
{
"name": "list_loadbalancers",
"description": "GET Referencing Loadbalancers.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}/loadbalancers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"loadbalancers": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "loadbalancers",
"type": "array",
"description": "Loadbalancers referencing the API Definition."
      }
]
}
]
},
	"local-kubeconfig": {
"name": "local-kubeconfig",
"displayName": "Local Kubeconfig",
"operations": [
{
"name": "create_local_kubeconfig",
"description": "Create K8s Cluster Local Kube Config.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/sites/{name}/local-kubeconfig",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Create kubeconfig request parameters.",
"title": "Create Kube Config Request",
"x-displayname": "Create Kube Config Request.",
"x-ves-proto-message": "ves.io.schema.site.CreateKubeConfigReq",
"properties": {
"name": {
"type": "string",
"description": "K8s Cluster name.",
"title": "Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Name",
"x-ves-example": "Ce398",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-example": "ce398",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64,
"min": 1
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "K8s Cluster namespace.",
"title": "Namespace",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64,
"min": 1
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteCreateKubeConfigReq",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteCreateKubeConfigReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for siteCreateKubeConfigReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "K8s Cluster name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64,
"min": 1
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "K8s Cluster namespace.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64,
"min": 1
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"local-kubeconfigs": {
"name": "local-kubeconfigs",
"displayName": "Local Kubeconfigs",
"operations": [
{
"name": "list_local_kubeconfigs",
"description": "List Local Kube Configs.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sites/{name}/local-kubeconfigs",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of kubeconfig items."
}
]
}
]
},
	"log-receiver-test": {
"name": "log-receiver-test",
"displayName": "Log Receiver Test",
"operations": [
{
"name": "create_log_receiver_test",
"description": "Test Global Log Receiver.",
"method": "POST",
"path": "/api/log_receiver/namespaces/{namespace}/global_log_receivers/{name}/test",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to send test log.",
"title": "Test Global Log Receiver Request",
"x-displayname": "Test Global Log Receiver Request.",
"x-ves-proto-message": "ves.io.schema.global_log_receiver.TestGlobalLogReceiverRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the Global log receiver.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Slack1",
"x-f5xc-example": "slack1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the Global log receiver is configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the Global log receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for global_log_receiverTestGlobalLogReceiverRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for global_log_receiverTestGlobalLogReceiverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "log"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for global_log_receiverTestGlobalLogReceiverRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the Global log receiver.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the Global log receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "object",
"description": ""
}
]
}
]
},
	"log-receivers": {
"name": "log-receivers",
"displayName": "Log Receivers",
"operations": [
{
"name": "create_log_receiver",
"description": "Create Log Receiver.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/log_receivers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of log_receiver",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.log_receiver.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/log_receiverCreateSpecType"
}
],
"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 log_receiverCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for log_receiverCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for log_receiverCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new Log Receiver object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog": {
"type": "object",
"description": "Configuration for syslog server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.syslog_rfc5424": {
"type": "integer",
"description": "Exclusive with []\nSelect RFC5424 syslog format and maximum message length.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 408,
"maximum": 268435456,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.tcp_server": {
"type": "object",
"description": "Name and port number for a TCP server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.tls_server": {
"type": "object",
"description": "TLS config for client of discovery service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.udp_server": {
"type": "object",
"description": "Name and port number for a UDP server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.log_receiver_choice": [
"syslog"
],
"spec.where_choice": [
"site_local"
],
"spec.syslog.format_choice": [
"syslog_rfc5424"
],
"spec.syslog.mode_choice": [
"tcp_server",
"tls_server",
"udp_server"
],
"spec.syslog.tls_server.ca_choice": [
"trusted_ca_url",
"volterra_ca"
],
"spec.syslog.tls_server.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.syslog.tls_server.port_choice": [
"default_https_port",
"default_syslog_tls_port",
"port"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_log_receiver",
"description": "Replace Log Receiver.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/log_receivers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a log_receiver",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.log_receiver.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/log_receiverReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for log_receiverReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for log_receiverReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for log_receiverReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of an Log Receiver object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog": {
"type": "object",
"description": "Configuration for syslog server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.syslog_rfc5424": {
"type": "integer",
"description": "Exclusive with []\nSelect RFC5424 syslog format and maximum message length.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 408,
"maximum": 268435456,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.tcp_server": {
"type": "object",
"description": "Name and port number for a TCP server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.tls_server": {
"type": "object",
"description": "TLS config for client of discovery service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.syslog.udp_server": {
"type": "object",
"description": "Name and port number for a UDP server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.log_receiver_choice": [
"syslog"
],
"spec.where_choice": [
"site_local"
],
"spec.syslog.format_choice": [
"syslog_rfc5424"
],
"spec.syslog.mode_choice": [
"tcp_server",
"tls_server",
"udp_server"
],
"spec.syslog.tls_server.ca_choice": [
"trusted_ca_url",
"volterra_ca"
],
"spec.syslog.tls_server.mtls_choice": [
"mtls_disabled",
"mtls_enable"
],
"spec.syslog.tls_server.port_choice": [
"default_https_port",
"default_syslog_tls_port",
"port"
]
}
},
{
"name": "list_log_receivers",
"description": "List Log Receiver.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/log_receivers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_log_receiver",
"description": "DELETE Log Receiver.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/log_receivers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a log_receiver",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.log_receiver.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for log_receiverDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for log_receiverDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
}
},
{
"name": "get_log_receiver",
"description": "GET Log Receiver.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/log_receivers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"lookup-user-roles": {
"name": "lookup-user-roles",
"displayName": "Lookup User Roles",
"operations": [
{
"name": "create_lookup_user_role",
"description": "Lookup User Roles.",
"method": "POST",
"path": "/api/web/namespaces/system/lookup-user-roles",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of LookupUserRoles request.",
"title": "LookupUserRolesReq",
"x-displayname": "Request for LookupUserRoles.",
"x-ves-proto-message": "ves.io.schema.namespace.LookupUserRolesReq",
"properties": {
"namespace": {
"type": "string",
"description": "Name of the namespace to lookup user roles.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the namespace to lookup user roles.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request body of LookupUserRoles request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceLookupUserRolesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceLookupUserRolesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"roles": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceLookupUserRolesReq"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Name of the namespace to lookup user roles.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "roles",
"type": "array",
"description": "List of user roles."
}
]
}
]
},
	"malicious-user-mitigations": {
"name": "malicious-user-mitigations",
"displayName": "Malicious User Mitigations",
"operations": [
{
"name": "create_malicious_user_mitigation",
"description": "Create Malicious User Mitigation.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/malicious_user_mitigations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of malicious_user_mitigation",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.malicious_user_mitigation.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/malicious_user_mitigationCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Malicious user mitigation configuration for challenge-based defense",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: malicious_user_mitigation\nmetadata:\n  name: example-mitigation\n  namespace: default\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-mitigation\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "secops_and_incident_response"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-mitigation",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Malicious user mitigation configuration for challenge-based defense"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create malicious_user_mitigation creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mitigation_type": {
"type": "object",
"description": "Settings that specify the actions to be taken when malicious users are determined to be at different threat levels.\nUser's activity is monitored and continuously analyzed for malicious behavior. From this analysis, a threat-level\nis assigned to each user. The settings defined in malicious user mitigation specify what mitigation actions to take\nfor user determined to be at different threat levels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mitigation_type.rules": {
"type": "array",
"description": "Define the threat levels and the corresponding mitigation actions to be taken.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_malicious_user_mitigation",
"description": "Replace Malicious User Mitigation.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/malicious_user_mitigations/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a malicious_user_mitigation",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.malicious_user_mitigation.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/malicious_user_mitigationReplaceSpecType"
}
],
"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": "Malicious user mitigation configuration for challenge-based defense",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: malicious_user_mitigation\nmetadata:\n  name: example-mitigation\n  namespace: default\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-mitigation\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "secops_and_incident_response"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-mitigation",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Malicious user mitigation configuration for challenge-based defense"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace malicious_user_mitigation replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mitigation_type": {
"type": "object",
"description": "Settings that specify the actions to be taken when malicious users are determined to be at different threat levels.\nUser's activity is monitored and continuously analyzed for malicious behavior. From this analysis, a threat-level\nis assigned to each user. The settings defined in malicious user mitigation specify what mitigation actions to take\nfor user determined to be at different threat levels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mitigation_type.rules": {
"type": "array",
"description": "Define the threat levels and the corresponding mitigation actions to be taken.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_malicious_user_mitigations",
"description": "List Malicious User Mitigation.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/malicious_user_mitigations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_malicious_user_mitigation",
"description": "DELETE Malicious User Mitigation.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/malicious_user_mitigations/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a malicious_user_mitigation",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.malicious_user_mitigation.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for malicious_user_mitigationDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for malicious_user_mitigationDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "secops_and_incident_response"
}
},
{
"name": "get_malicious_user_mitigation",
"description": "GET Malicious User Mitigation.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/malicious_user_mitigations/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"malware-protection-addon-subscribe": {
"name": "malware-protection-addon-subscribe",
"displayName": "Malware Protection Addon Subscribe",
"operations": [
{
"name": "create_malware_protection_addon_subscribe",
"description": "Subscribe to Malware Protection.",
"method": "POST",
"path": "/api/config/namespaces/system/malware_protection/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Malware Protection.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.malware_protection.subscription.SubscribeRequest",
"x-f5xc-description-short": "Request to subscribe to Malware Protection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"malware-protection-addon-unsubscribe": {
"name": "malware-protection-addon-unsubscribe",
"displayName": "Malware Protection Addon Unsubscribe",
"operations": [
{
"name": "create_malware_protection_addon_unsubscribe",
"description": "Unsubscribe to Malware Protection.",
"method": "POST",
"path": "/api/config/namespaces/system/malware_protection/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Malware Protection.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.malware_protection.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to Malware Protection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"managed-client-customer-supports": {
"name": "managed-client-customer-supports",
"displayName": "Managed Client Customer Supports",
"operations": [
{
"name": "list_managed_client_customer_supports",
"description": "List tickets of managed tenant.",
"method": "GET",
"path": "/api/web/namespaces/system/managed_client/customer_supports",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "create_managed_client_customer_support",
"description": "Create customer support ticket in managed tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/managed_client/customer_supports",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of customer_support",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.customer_support.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/schemacustomer_supportCreateSpecType__ves_io_schema_tenant_management_child_tenant"
}
],
"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 schemacustomer_supportCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schemacustomer_supportCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schemacustomer_supportCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new customer support ticket in our customer support provider system.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.category": {
"type": "string",
"description": "Ticket area further narrows down the ticket - infrastructure, application,\ndashboards can be examples.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.comments": {
"type": "array",
"description": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.description": {
"type": "string",
"description": "Customer's description of the issue (free text)",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ongoing": {
"type": "boolean",
"description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.priority": {
"type": "string",
"description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRIORITY_UNKNOWN"
},
"spec.product_data": {
"type": "string",
"description": "Product data is a free text field that can be used to describe the issue in more detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.relates_to": {
"type": "array",
"description": "Optional reference to any original ticket in case the ticket being created is a followup.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service": {
"type": "string",
"description": "Indicates the list of support service\n\nUnknown Support Service\nAccount Protection Support Service\nAdministration Support Service\nApplication Traffic Insight Support Service\nAudit Logs & Alerts Support Service\nAuthentication Intelligence Support Service\nBilling Support Service\nClient Side Defense Support Service\nCloud & Edge Sites Support Service\ndeprecated: use SS_MULTI_CLOUD_NETWORK_CONNECT instead\nDDoS & Transit Support Service\nDeprecated: use SS_ROUTED_DDOS instead\nDistributed Apps Support Service\nDNS Management Support Service\nLoadBalancers Support Service\ndeprecated: use SS_MULTI_CLOUD_APP_CONNECT instead\nShared Configuration Support Service\nWeb App & API Protection Support Service\nOther Support Service\nBot Defense Support Service\nContent delivery network Support Service\nObservability Support Service\nDelegated Access Support Service\nNetworking & security across clouds, edge and on-premises\nConnect apps across clouds, edge and on-premises using Load Balancers\nData Intelligence Support Service\nNGINX One Support Service\nWeb App Scanning Support Service\nRouted DDoS Support Service\nMobile App Shield protects mobile apps from reverse engineering, tampering and malware\nDefault for deprecated services\nAutomation Support Service for Terraform Provider.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SS_UNKNOWN"
},
"spec.status": {
"type": "string",
"description": "State of the ticket so the customers know if the problem is being looked into\n\nUnknown or empty support ticket status\nIndicates a new ticket, waiting to be assigned to an agent\nIndicates an open issues, actively being looked into\nIndicates a pending issue, an open issue not actively being looked into\nIndicates on issue that on-hold, waiting for more information\nIndicates a solved issue, waiting for customer's confirmation\nIndicates a closed issue, resolved and customer approved\nIndicates a failed ticket, a failed ticket didn't make it into Salesforce and a customer should create new one instead.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "STATUS_UNKNOWN"
},
"spec.subject": {
"type": "string",
"description": "Subject of the ticket.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timeline": {
"type": "string",
"description": "Timeline is a free text field that can be used to describe the issue in more detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timezone": {
"type": "string",
"description": "Stores the timezone provided by the user at the time of support ticket creation.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z_]+/[A-Z][a-zA-Z_]+$",
"formatDescription": "IANA timezone database (e.g., America/New_York)",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.topic": {
"type": "string",
"description": "Support Topic indicates the list of topics for service tickets\n\nUnknown/empty priority\nACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST\nACCOUNT_SUPPORT_TOPIC_ACCOUNT\nACCOUNT_SUPPORT_TOPIC_BILLING\nACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE\nACCOUNT_SUPPORT_TOPIC_PUBLIC_IP\nACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE\nACCOUNT_SUPPORT_TOPIC_RMA\nACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION\nACCOUNT_SUPPORT_TOPIC_OTHERS\nTECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES\nTECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE\nTECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION\nTECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION\nTECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING\nTECHNICAL_SUPPORT_TOPIC_OTHERS\nINCIDENT_SUPPORT_TOPIC_LATENCY\nINCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION\nINCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE\nINCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE\nINCIDENT_SUPPORT_TOPIC_OTHERS\nTASK_TOPIC_PLAN_TRANSITION\nPROBLEM_TOPIC_SUPPORT_ALERT\nQUESTION_TOPIC_INFRASTRUCTURE\nTECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION\nTECHNICAL_SUPPORT_TOPIC_TERRAFORM_PROVIDER.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TOPIC_UNKNOWN"
},
"spec.tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type": {
"type": "string",
"description": "Several types of issues are supported, such as problems, questions.\n\nUnknown or empty ticket type\nIndicates a problem (e.g. Misconfiguration)\nIndicates a task (a request to do something)\nIndicates a question (billing, services related)\nIndicates an incident (something is not working)\nIndicates a technical support ticket\nIndicates an account support ticket\nIndicates an Incident support ticket.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TYPE_UNKNOWN"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "get_managed_client_customer_support",
"description": "GET customer support ticket in managed tenant.",
"method": "GET",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"managed-client-customer-supports-close": {
"name": "managed-client-customer-supports-close",
"displayName": "Managed Client Customer Supports Close",
"operations": [
{
"name": "create_managed_client_customer_supports_close",
"description": "Close a customer support ticket in managed tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/close",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Input request to fetch customer_support ticket in child / managed tenant.",
"title": "SupportTicketRequest",
"x-displayname": "Support Ticket Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest",
"properties": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSupportTicketRequest"
},
"fieldMetadata": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"managed-client-customer-supports-comment": {
"name": "managed-client-customer-supports-comment",
"displayName": "Managed Client Customer Supports Comment",
"operations": [
{
"name": "create_managed_client_customer_supports_comment",
"description": "Add comment to a customer support ticket in managed tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Adds a new comment to an existing customer support ticket.",
"title": "CommentRequest",
"x-displayname": "Customer support ticket comment request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.CommentRequest",
"properties": {
"attachments": {
"type": "array",
"description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"title": "Binary attachments",
"items": {
"$ref": "#/components/schemas/customer_supportAttachmentType"
},
"x-displayname": "Attachments.",
"x-f5xc-description-short": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"comment": {
"type": "string",
"description": "Comment on a existing customer support ticket.",
"title": "comment",
"x-displayname": "Comment",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Comment on a existing customer support ticket.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Adds a new comment to an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schematenant_managementCommentRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schematenant_managementCommentRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schematenant_managementCommentRequest"
},
"fieldMetadata": {
"attachments": {
"type": "array",
"description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"comment": {
"type": "string",
"description": "Comment on a existing customer support ticket.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"managed-client-customer-supports-comment-attachment": {
"name": "managed-client-customer-supports-comment-attachment",
"displayName": "Managed Client Customer Supports Comment Attachment",
"operations": [
{
"name": "get_managed_client_customer_supports_comment_attachment",
"description": "GET attachment.",
"method": "GET",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment/{comment_id}/attachment/{attachment_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "comment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "attachment_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"managed-client-customer-supports-escalate": {
"name": "managed-client-customer-supports-escalate",
"displayName": "Managed Client Customer Supports Escalate",
"operations": [
{
"name": "create_managed_client_customer_supports_escalate",
"description": "Escalate a ticket in managed tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/escalate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Input request to fetch customer_support ticket in child / managed tenant.",
"title": "SupportTicketRequest",
"x-displayname": "Support Ticket Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest",
"properties": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSupportTicketRequest"
},
"fieldMetadata": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"managed-client-customer-supports-priority": {
"name": "managed-client-customer-supports-priority",
"displayName": "Managed Client Customer Supports Priority",
"operations": [
{
"name": "create_managed_client_customer_supports_priority",
"description": "Priority of a ticket in managed tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/priority",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Priority of an existing customer support ticket.",
"title": "PriorityRequest",
"x-displayname": "Customer support ticket priority request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.PriorityRequest",
"properties": {
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/customer_supportSupportTicketPriority"
}
],
"x-f5xc-example": "10",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Priority of an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schematenant_managementPriorityRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schematenant_managementPriorityRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schematenant_managementPriorityRequest"
},
"fieldMetadata": {
"priority": {
"type": "string",
"description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRIORITY_UNKNOWN"
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"managed-client-customer-supports-reopen": {
"name": "managed-client-customer-supports-reopen",
"displayName": "Managed Client Customer Supports Reopen",
"operations": [
{
"name": "create_managed_client_customer_supports_reopen",
"description": "Reopen a closed customer support ticket in managed tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/managed_client/customer_supports/{tp_id}/reopen",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Input request to fetch customer_support ticket in child / managed tenant.",
"title": "SupportTicketRequest",
"x-displayname": "Support Ticket Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest",
"properties": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSupportTicketRequest"
},
"fieldMetadata": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"managed-tenants": {
"name": "managed-tenants",
"displayName": "Managed Tenants",
"operations": [
{
"name": "create_managed_tenant",
"description": "Create Managed Tenant.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/managed_tenants",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of managed_tenant",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.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/tenant_managementmanaged_tenantCreateSpecType"
}
],
"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 tenant_managementmanaged_tenantCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementmanaged_tenantCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementmanaged_tenantCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a managed_tenant config instance. Name of the object is name of the tenant that is allowed to manage.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.groups": {
"type": "array",
"description": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_id": {
"type": "string",
"description": "Exclusive with []\nSpecify the Tenant ID of the existing tenant which needs to be managed.\nUser can select Tenant ID from dropdown if managed tenant has already configured delegated access\nor manually input the Tenant ID if managed tenant configuration will happen in future.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.tenant_choice": [
"tenant_id"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_managed_tenant",
"description": "Replace Managed Tenant.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/managed_tenants/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a managed_tenant",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.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/tenant_managementmanaged_tenantReplaceSpecType"
}
],
"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 managed_tenantReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for managed_tenantReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for managed_tenantReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a managed_tenant configuration.\nUpdate of existing tenant_choice selection is not supported but user may update existing group assignments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.groups": {
"type": "array",
"description": "List of local user group association to user groups in the managed tenant specified in the tenant_choice.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_managed_tenants",
"description": "List Managed Tenant.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/managed_tenants",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_managed_tenant",
"description": "DELETE Managed Tenant.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/managed_tenants/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a managed_tenant",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.managed_tenant.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for managed_tenantDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for managed_tenantDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_managed_tenant",
"description": "GET Managed Tenant.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/managed_tenants/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"managed-tenants-by-user": {
"name": "managed-tenants-by-user",
"displayName": "Managed Tenants By User",
"operations": [
{
"name": "list_managed_tenants_by_user",
"description": "GET List of Managed Tenant By User.",
"method": "GET",
"path": "/api/web/namespaces/system/managed_tenants_by_user",
      "dangerLevel": "low",
"parameters": [
{
"name": "search_keyword",
      "in": "query",
"required": false,
"type": "string"
},
{
"name": "page_start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page_limit",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"access_config": {
      "type": "array"
},
"next_page": {
"type": "string"
},
"total_access_config_count": {
      "type": "integer"
},
"total_count": {
"type": "integer"
},
"total_filtered_count": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "access_config",
      "type": "array",
"description": "Allowed access configuration details for the tenant."
      },
{
"field": "next_page",
"type": "string",
"description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page."
},
{
"field": "total_access_config_count",
      "type": "integer",
"description": "TotalAccessConfigCount holds total count of access config.\nThis is deprecated, use TotalCount instead."
      },
{
"field": "total_count",
"type": "integer",
"description": "TotalCount holds total count of access config."
      },
{
"field": "total_filtered_count",
"type": "integer",
"description": "TotalFilteredCount holds total count of access config after filtering."
      }
]
}
]
},
	"managed-tenants-list": {
"name": "managed-tenants-list",
"displayName": "Managed Tenants List",
"operations": [
{
"name": "list_managed_tenants_list",
"description": "GET List of Managed Tenant.",
"method": "GET",
"path": "/api/web/namespaces/system/managed_tenants_list",
      "dangerLevel": "low",
"parameters": [
{
"name": "search_keyword",
      "in": "query",
"required": false,
"type": "string"
},
{
"name": "page_start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page_limit",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"access_config": {
      "type": "array"
},
"next_page": {
"type": "string"
},
"total_access_config_count": {
      "type": "integer"
},
"total_count": {
"type": "integer"
},
"total_filtered_count": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "access_config",
      "type": "array",
"description": "Allowed access configuration details for the tenant."
      },
{
"field": "next_page",
"type": "string",
"description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page."
},
{
"field": "total_access_config_count",
      "type": "integer",
"description": "TotalAccessConfigCount holds total count of access config.\nThis is deprecated, use TotalCount instead."
      },
{
"field": "total_count",
"type": "integer",
"description": "TotalCount holds total count of access config."
      },
{
"field": "total_filtered_count",
"type": "integer",
"description": "TotalFilteredCount holds total count of access config after filtering."
      }
]
}
]
},
	"mark-as-non-api": {
"name": "mark-as-non-api",
      "displayName": "Mark As Non Api",
      "operations": [
{
"name": "create_mark_as_non_api",
      "description": "Mark As Non-API.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}/mark_as_non_api",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for various API Inventory Requests.",
      "title": "API Inventory Request",
      "x-displayname": "API Inventory Request.",
      "x-ves-proto-message": "ves.io.schema.views.api_definition.APInventoryReq",
      "properties": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "title": "API Endpoints",
      "minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/viewsApiOperation"
      },
"x-displayname": "API Endpoints.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "The list of API endpoints for the API Inventory request.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "title": "Name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for various API Inventory Requests.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_definitionAPInventoryReq",
      "required_fields": [
"api_endpoints"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_definitionAPInventoryReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  api_endpoints: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"api_endpoints\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"updated_api_endpoints": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"api_endpoints": "value"
      }
},
"requiredFields": [
"api_endpoints"
      ],
"description": "Minimum configuration for api_definitionAPInventoryReq"
      },
"fieldMetadata": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "updated_api_endpoints",
      "type": "array",
"description": "The list of API endpoints which were successfully proceeded by the API Inventory request."
      }
]
}
]
},
	"maurice-pre-upgrade-check": {
"name": "maurice-pre-upgrade-check",
"displayName": "Maurice Pre Upgrade Check",
"operations": [
{
"name": "list_maurice_pre_upgrade_check",
"description": "Pre upgrade check.",
"method": "GET",
"path": "/api/maurice/namespaces/{namespace}/sites/{name}/pre_upgrade_check",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "sw_version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"checklist": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "checklist",
"type": "array",
"description": "Checklist containing the items for pre upgrade check."
}
]
}
]
},
	"maurice-software-os-version": {
"name": "maurice-software-os-version",
"displayName": "Maurice Software Os Version",
"operations": [
{
"name": "create_maurice_software_os_version",
"description": "GET OS based on SW_VERSION.",
"method": "POST",
"path": "/api/maurice/software_os_version",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request containing the sw_version.",
"title": "GetImageOsRequest",
"x-displayname": "Software Version to OS Image Mapping.",
"x-ves-proto-message": "ves.io.schema.virtual_appliance.GetImageRequest",
"properties": {
"uids": {
"type": "array",
"description": "Configuration parameter for uids",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "string"
},
"x-displayname": "UIDs",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true",
"ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"
},
"x-f5xc-example": "[\"00000000-0000-4000-8000-d36e055b3ea2\", \"00000000-0000-4000-8000-631b8bae734e\"]",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true",
"ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"
},
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_applianceGetImageRequest",
"required_fields": [
"uids"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_applianceGetImageRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  uids: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"uids\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {
"images": {
"type": "object"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"uids": "value"
}
},
"requiredFields": [
"uids"
],
"description": "Minimum configuration for virtual_applianceGetImageRequest"
},
"fieldMetadata": {
"uids": {
"type": "array",
"description": "Configuration parameter for uids",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "images",
"type": "object",
"description": "Map of UID to image info."
}
]
}
]
},
	"maurice-upgradable-sw-versions": {
"name": "maurice-upgradable-sw-versions",
"displayName": "Maurice Upgradable Sw Versions",
"operations": [
{
"name": "list_maurice_upgradable_sw_versions",
"description": "GET Upgradable SW Versions.",
"method": "GET",
"path": "/api/maurice/upgradable_sw_versions",
      "dangerLevel": "low",
"parameters": [
{
"name": "current_os_version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "current_sw_version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"sw_versions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "sw_versions",
"type": "array",
"description": "Fetch upgradable sw versions for site."
}
]
}
]
},
	"maurice-upgrade-status": {
"name": "maurice-upgrade-status",
"displayName": "Maurice Upgrade Status",
"operations": [
{
"name": "list_maurice_upgrade_status",
"description": "GET Upgrade Status.",
"method": "GET",
"path": "/api/maurice/namespaces/{namespace}/sites/{name}/upgrade_status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "upgrade_status",
"type": "object",
"description": ""
}
]
}
]
},
	"metrics": {
"name": "metrics",
"displayName": "Metrics",
"operations": [
{
"name": "create_metric",
"description": "Metrics",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_firewall/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the metrics for App Firewall.",
"title": "Metrics Request",
"x-displayname": "Metrics Request.",
"x-ves-proto-message": "ves.io.schema.app_firewall.MetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/schemaapp_firewallMetricType"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{NAMESPACE=\\\"example-namespace\"}",
"x-f5xc-example": "\"{NAMESPACE=\\\"example-namespace\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = : equal to != : not equal to =~ : regex match !~ : not regex match Optional: If not specified, metric...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/app_firewallMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"format": "boolean",
"x-displayname": "Trend calculation requested by the user.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the metrics for App Firewall.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_firewallMetricsRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_firewallMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for app_firewallMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series metric data for App Firewall."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"metrics-client-rule-hits": {
"name": "metrics-client-rule-hits",
"displayName": "Metrics Client Rule Hits",
"operations": [
{
"name": "create_metrics_client_rule_hit",
"description": "Client Rule Hits Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/wafs/metrics/client/rule_hits",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET number of rule hits per client/server for a given namespace.",
"title": "RuleHitsCountRequest",
"x-displayname": "Rule Hits Count Request.",
"x-ves-proto-message": "ves.io.schema.waf.RuleHitsCountRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/wafMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one of more labels listed here.",
"x-f5xc-description-medium": "Aggregate data by one of more labels listed here. NAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG. Optional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/wafMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF rule hits for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Namespace is used to scope the WAF rule hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "50m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "50m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET number of rule hits per client/server for a given namespace.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for wafRuleHitsCountRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for wafRuleHitsCountRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for wafRuleHitsCountRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF rule hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of rule hits counter data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"metrics-client-security-events": {
"name": "metrics-client-security-events",
"displayName": "Metrics Client Security Events",
"operations": [
{
"name": "create_metrics_client_security_event",
"description": "Client Security Events Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/wafs/metrics/client/security_events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET number of security events per client/server for a given namespace.",
"title": "SecurityEventsCountRequest",
"x-displayname": "Security Events Count Request.",
"x-ves-proto-message": "ves.io.schema.waf.SecurityEventsCountRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one or more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/wafMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one or more labels listed here. NAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.",
"x-f5xc-description-medium": "Aggregate data by one or more labels listed here. NAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE. Optional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/wafMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF security events for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Namespace is used to scope the WAF security events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "45m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "45m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "15m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "15m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET number of security events per client/server for a given namespace.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for wafSecurityEventsCountRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for wafSecurityEventsCountRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for wafSecurityEventsCountRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one or more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF security events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of security events counter data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"metrics-server-rule-hits": {
"name": "metrics-server-rule-hits",
"displayName": "Metrics Server Rule Hits",
"operations": [
{
"name": "create_metrics_server_rule_hit",
"description": "Server Rule Hits Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/wafs/metrics/server/rule_hits",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET number of rule hits per client/server for a given namespace.",
"title": "RuleHitsCountRequest",
"x-displayname": "Rule Hits Count Request.",
"x-ves-proto-message": "ves.io.schema.waf.RuleHitsCountRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/wafMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one of more labels listed here.",
"x-f5xc-description-medium": "Aggregate data by one of more labels listed here. NAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG. Optional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/wafMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF rule hits for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Namespace is used to scope the WAF rule hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "50m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "50m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET number of rule hits per client/server for a given namespace.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for wafRuleHitsCountRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for wafRuleHitsCountRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for wafRuleHitsCountRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one of more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF rule hits for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of rule hits counter data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"metrics-server-security-events": {
"name": "metrics-server-security-events",
"displayName": "Metrics Server Security Events",
"operations": [
{
"name": "create_metrics_server_security_event",
"description": "Server Security Events Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/wafs/metrics/server/security_events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET number of security events per client/server for a given namespace.",
"title": "SecurityEventsCountRequest",
"x-displayname": "Security Events Count Request.",
"x-ves-proto-message": "ves.io.schema.waf.SecurityEventsCountRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one or more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/wafMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one or more labels listed here. NAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.",
"x-f5xc-description-medium": "Aggregate data by one or more labels listed here. NAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE. Optional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/wafMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF security events for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Namespace is used to scope the WAF security events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "45m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "45m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "15m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "15m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET number of security events per client/server for a given namespace.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for wafSecurityEventsCountRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for wafSecurityEventsCountRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for wafSecurityEventsCountRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one or more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the rule hits are aggregated/grouped by VIRTUAL_HOST.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nAPP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the WAF security events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of security events counter data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"mobile-app-shield-mobile-app-shield-addon-subscribe": {
"name": "mobile-app-shield-mobile-app-shield-addon-subscribe",
"displayName": "Mobile App Shield Mobile App Shield Addon Subscribe",
"operations": [
{
"name": "create_mobile_app_shield_mobile_app_shield_addon_subscribe",
"description": "Subscribe to Mobile App Shield.",
"method": "POST",
"path": "/api/mobile/app-shield/namespaces/system/mobile-app-shield/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Mobile App Shield.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.mobile_app_shield.subscription.SubscribeRequest",
"x-f5xc-description-short": "Request to subscribe to Mobile App Shield.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"mobile-app-shield-mobile-app-shield-addon-unsubscribe": {
"name": "mobile-app-shield-mobile-app-shield-addon-unsubscribe",
"displayName": "Mobile App Shield Mobile App Shield Addon Unsubscribe",
"operations": [
{
"name": "create_mobile_app_shield_mobile_app_shield_addon_unsubscribe",
"description": "Unsubscribe to Mobile App Shield.",
"method": "POST",
"path": "/api/mobile/app-shield/namespaces/system/mobile-app-shield/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Mobile App Shield.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.mobile_app_shield.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to Mobile App Shield.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"mobile-integrator-mobile-integrator-addon-subscribe": {
"name": "mobile-integrator-mobile-integrator-addon-subscribe",
"displayName": "Mobile Integrator Mobile Integrator Addon Subscribe",
"operations": [
{
"name": "create_mobile_integrator_mobile_integrator_addon_subscribe",
"description": "Subscribe to Mobile Integrator.",
"method": "POST",
"path": "/api/mobile/integrator/namespaces/system/mobile-integrator/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Mobile Integrator.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.mobile_integrator.subscription.SubscribeRequest",
"x-f5xc-description-short": "Request to subscribe to Mobile Integrator.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"mobile-integrator-mobile-integrator-addon-unsubscribe": {
"name": "mobile-integrator-mobile-integrator-addon-unsubscribe",
"displayName": "Mobile Integrator Mobile Integrator Addon Unsubscribe",
"operations": [
{
"name": "create_mobile_integrator_mobile_integrator_addon_unsubscribe",
"description": "Unsubscribe to Mobile Integrator.",
"method": "POST",
"path": "/api/mobile/integrator/namespaces/system/mobile-integrator/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Mobile Integrator.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.mobile_integrator.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to Mobile Integrator.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"mobile-security": {
"name": "mobile-security",
"displayName": "Mobile Security",
"operations": [
{
"name": "create_mobile_security",
"description": "Create Mobile SDK Base Configuration.",
"method": "POST",
"path": "/api/mobile/security/namespaces/{namespace}/mobile_base_configs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of mobile_base_config",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.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/mobile_base_configCreateSpecType"
}
],
"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 mobile_base_configCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for mobile_base_configCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for mobile_base_configCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Mobile SDK Base Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.fqdn": {
"type": "string",
"description": "Fully qualified domain name (FQDN)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "hostname",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.os": {
"type": "string",
"description": "Defines an operation system for Mobile SDK\n\n- MOBILE_OS_UNDEFINED: MOBILE_OS_UNDEFINED\n\nUndefined Operating System\n- ANDROID: ANDROID\n\nAndroid\n- IOS: IOS\n\niOS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MOBILE_OS_UNDEFINED"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_mobile_security",
"description": "Replace Mobile SDK Base Configuration.",
"method": "PUT",
"path": "/api/mobile/security/namespaces/{namespace}/mobile_base_configs/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a mobile_base_config",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.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/mobile_base_configReplaceSpecType"
}
],
"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 mobile_base_configReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for mobile_base_configReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for mobile_base_configReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Mobile SDK Base Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.fqdn": {
"type": "string",
"description": "Fully qualified domain name (FQDN)",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "hostname",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.os": {
"type": "string",
"description": "Defines an operation system for Mobile SDK\n\n- MOBILE_OS_UNDEFINED: MOBILE_OS_UNDEFINED\n\nUndefined Operating System\n- ANDROID: ANDROID\n\nAndroid\n- IOS: IOS\n\niOS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MOBILE_OS_UNDEFINED"
}
}
},
{
"name": "get_mobile_security",
"description": "GET Mobile Base Configuration File.",
"method": "GET",
"path": "/api/mobile/security/namespaces/{namespace}/mobile_base_config_file/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "content",
"type": "string",
"description": "Mobile SDK Base Configuration content."
},
{
"field": "name",
"type": "string",
"description": "Mobile SDK Base Configuration file name."
}
]
},
{
"name": "list_mobile_security",
"description": "List Mobile SDK Base Configuration.",
"method": "GET",
"path": "/api/mobile/security/namespaces/{namespace}/mobile_base_configs",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_mobile_security",
"description": "DELETE Mobile SDK Base Configuration.",
"method": "DELETE",
"path": "/api/mobile/security/namespaces/{namespace}/mobile_base_configs/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a mobile_base_config",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for mobile_base_configDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for mobile_base_configDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
}
}
]
},
	"monthly-usage": {
"name": "monthly-usage",
"displayName": "Monthly Usage",
"operations": [
{
"name": "create_monthly_usage",
"description": "List monthly usage details.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/monthly_usage",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request message to GET mon thly usage details.",
"title": "List monthly usage details request",
"x-displayname": "List monthly usage details request.",
"x-ves-proto-message": "ves.io.schema.usage.ListMonthlyUsageReq",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace to be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request message to GET mon thly usage details.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usageListMonthlyUsageReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usageListMonthlyUsageReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"monthly_usage_items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usageListMonthlyUsageReq"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace to be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "monthly_usage_items",
"type": "array",
"description": "Collection of usage items, lines of response."
}
]
}
]
},
	"move-to-inventory": {
"name": "move-to-inventory",
"displayName": "Move To Inventory",
"operations": [
{
"name": "create_move_to_inventory",
"description": "Move To API Inventory.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}/move_to_inventory",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for various API Inventory Requests.",
      "title": "API Inventory Request",
      "x-displayname": "API Inventory Request.",
      "x-ves-proto-message": "ves.io.schema.views.api_definition.APInventoryReq",
      "properties": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "title": "API Endpoints",
      "minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/viewsApiOperation"
      },
"x-displayname": "API Endpoints.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "The list of API endpoints for the API Inventory request.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "title": "Name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for various API Inventory Requests.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_definitionAPInventoryReq",
      "required_fields": [
"api_endpoints"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_definitionAPInventoryReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  api_endpoints: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"api_endpoints\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"updated_api_endpoints": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"api_endpoints": "value"
      }
},
"requiredFields": [
"api_endpoints"
      ],
"description": "Minimum configuration for api_definitionAPInventoryReq"
      },
"fieldMetadata": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "updated_api_endpoints",
      "type": "array",
"description": "The list of API endpoints which were successfully proceeded by the API Inventory request."
      }
]
}
]
},
	"namespace-roles": {
"name": "namespace-roles",
"displayName": "Namespace Roles",
"operations": [
{
"name": "list_namespace_roles",
"description": "List Namespace Role.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/namespace_roles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_namespace_role",
"description": "GET Namespace Role.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/namespace_roles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"namespaces": {
"name": "namespaces",
"displayName": "Namespaces",
"operations": [
{
"name": "list_namespaces",
"description": "List Namespace.",
"method": "GET",
"path": "/api/web/namespaces",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "create_namespace",
"description": "Create Namespace.",
"method": "POST",
"path": "/api/web/namespaces",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of namespace",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.namespace.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/schemanamespaceCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Logical grouping for F5 XC resources within a tenant",
"required_fields": [
"metadata.name"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: namespace\nmetadata:\n  name: example-ns\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-ns\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-ns"
},
"spec": {}
},
"requiredFields": [
"metadata.name"
],
"description": "Logical grouping for F5 XC resources within a tenant"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new namespace. Name of the object is name of the name space.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_namespace",
"description": "Replace Namespace.",
"method": "PUT",
"path": "/api/web/namespaces/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a namespace",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.namespace.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemanamespaceReplaceSpecType"
}
],
"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": "Logical grouping for F5 XC resources within a tenant",
"required_fields": [
"metadata.name"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: namespace\nmetadata:\n  name: example-ns\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-ns\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-ns"
},
"spec": {}
},
"requiredFields": [
"metadata.name"
],
"description": "Logical grouping for F5 XC resources within a tenant"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a namespace including its metadata like labels, description etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "get_namespace",
"description": "GET Namespace.",
"method": "GET",
"path": "/api/web/namespaces/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"nat-policys": {
"name": "nat-policys",
"displayName": "Nat Policys",
"operations": [
{
"name": "create_nat_policy",
"description": "Create NAT Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/nat_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of nat_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.nat_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/nat_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nat_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nat_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nat_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "NAT Policy create specification configures NAT Policy with multiple Rules,.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "List of rules to apply under the NAT Policy. Rule that matches first would be applied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.site": {
"type": "object",
"description": "Reference to Site Object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site.refs": {
"type": "array",
"description": "Reference to Site Object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.applies_to_choice": [
"site"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_nat_policy",
"description": "Replace NAT Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/nat_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a nat_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.nat_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/nat_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nat_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nat_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nat_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "NAT Policy replaces specification configures NAT Policy with multiple Rules,\ncorresponding Match Criteria to apply on the packet content and Action to be\napplied ifthe MatchCriteria matches.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "List of rules to apply under the NAT Policy. Rule that matches first would be applied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.site": {
"type": "object",
"description": "Reference to Site Object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site.refs": {
"type": "array",
"description": "Reference to Site Object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.applies_to_choice": [
"site"
]
}
},
{
"name": "list_nat_policys",
"description": "List NAT Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nat_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_nat_policy",
"description": "DELETE NAT Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/nat_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a nat_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.nat_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nat_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nat_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_nat_policy",
"description": "GET NAT Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nat_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"navigation-tiles": {
"name": "navigation-tiles",
"displayName": "Navigation Tiles",
"operations": [
{
"name": "list_navigation_tiles",
"description": "List Navigation Tile.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/navigation_tiles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_navigation_tile",
"description": "GET Navigation Tile.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/navigation_tiles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"network-connectors": {
"name": "network-connectors",
"displayName": "Network Connectors",
"operations": [
{
"name": "create_network_connector",
"description": "Create Network Connector.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/network_connectors",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of network_connector",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.network_connector.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/network_connectorCreateSpecType"
}
],
"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 network_connectorCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_connectorCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for network_connectorCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Network Connector is created by users in system namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy": {
"type": "object",
"description": "Fine tune forward proxy behavior\n\nFew configurations allowed are\n\nWhite listed ports and IP prefixes:\nForward proxy does application protocol detection and server name(SNI) detection by peeking into\nthe traffic on the incoming downstream connection. Few protocols doesn't have client sending\nthe first data. In such cases, protocol and SNI detection fails. This configuration allows,\nskipping protocol and SNI detection for whitelisted IP-prefix-list and ports\nconnection_timeout:\nThe timeout for new network connections to upstream server.\nMax_connect_attempts:\nMaximum number of attempts made to make new network connection to upstream server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.max_connect_attempts": {
"type": "integer",
"description": "Specifies the allowed number of retries on connect failure to upstream server. Defaults to 1.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 8,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.no_interception": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.tls_intercept": {
"type": "object",
"description": "Configuration to enable TLS interception.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.white_listed_ports": {
"type": "array",
"description": "Traffic to these destination TCP ports is not subjected to protocol parsing\nExample \"tmate\" server port.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.white_listed_prefixes": {
"type": "array",
"description": "Traffic to these destination IP prefixes is not subjected to protocol parsing\nExample \"tmate\" server IP.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_global_dr": {
"type": "object",
"description": "Global network reference for direct connection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_global_dr.global_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_slo_snat": {
"type": "object",
"description": "X-example: \"\"\ndescription.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_slo_snat.default_gw_snat": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_slo_snat.interface_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slo_to_global_dr": {
"type": "object",
"description": "Global network reference for direct connection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slo_to_global_dr.global_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.connector_choice": [
"sli_to_global_dr",
"sli_to_slo_snat",
"slo_to_global_dr"
],
"spec.forward_proxy_choice": [
"disable_forward_proxy",
"enable_forward_proxy"
],
"spec.enable_forward_proxy.tls_interception_choice": [
"no_interception",
"tls_intercept"
],
"spec.enable_forward_proxy.tls_intercept.interception_policy_choice": [
"enable_for_all_domains",
"policy"
],
"spec.enable_forward_proxy.tls_intercept.signing_cert_choice": [
"custom_certificate",
"volterra_certificate"
],
"spec.enable_forward_proxy.tls_intercept.trusted_ca_choice": [
"trusted_ca_url",
"volterra_trusted_ca"
],
"spec.sli_to_slo_snat.pool_choice": [
"interface_ip"
],
"spec.sli_to_slo_snat.routing_choice": [
"default_gw_snat"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_network_connector",
"description": "Replace Network Connector.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/network_connectors/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a network_connector",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.network_connector.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/network_connectorReplaceSpecType"
}
],
"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 network_connectorReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_connectorReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for network_connectorReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Network Connector will replace the contains of given object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy": {
"type": "object",
"description": "Fine tune forward proxy behavior\n\nFew configurations allowed are\n\nWhite listed ports and IP prefixes:\nForward proxy does application protocol detection and server name(SNI) detection by peeking into\nthe traffic on the incoming downstream connection. Few protocols doesn't have client sending\nthe first data. In such cases, protocol and SNI detection fails. This configuration allows,\nskipping protocol and SNI detection for whitelisted IP-prefix-list and ports\nconnection_timeout:\nThe timeout for new network connections to upstream server.\nMax_connect_attempts:\nMaximum number of attempts made to make new network connection to upstream server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.max_connect_attempts": {
"type": "integer",
"description": "Specifies the allowed number of retries on connect failure to upstream server. Defaults to 1.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 8,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.no_interception": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.tls_intercept": {
"type": "object",
"description": "Configuration to enable TLS interception.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.white_listed_ports": {
"type": "array",
"description": "Traffic to these destination TCP ports is not subjected to protocol parsing\nExample \"tmate\" server port.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_forward_proxy.white_listed_prefixes": {
"type": "array",
"description": "Traffic to these destination IP prefixes is not subjected to protocol parsing\nExample \"tmate\" server IP.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_global_dr": {
"type": "object",
"description": "Global network reference for direct connection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_global_dr.global_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_slo_snat": {
"type": "object",
"description": "X-example: \"\"\ndescription.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_slo_snat.default_gw_snat": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sli_to_slo_snat.interface_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slo_to_global_dr": {
"type": "object",
"description": "Global network reference for direct connection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slo_to_global_dr.global_vn": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.connector_choice": [
"sli_to_global_dr",
"sli_to_slo_snat",
"slo_to_global_dr"
],
"spec.forward_proxy_choice": [
"disable_forward_proxy",
"enable_forward_proxy"
],
"spec.enable_forward_proxy.tls_interception_choice": [
"no_interception",
"tls_intercept"
],
"spec.enable_forward_proxy.tls_intercept.interception_policy_choice": [
"enable_for_all_domains",
"policy"
],
"spec.enable_forward_proxy.tls_intercept.signing_cert_choice": [
"custom_certificate",
"volterra_certificate"
],
"spec.enable_forward_proxy.tls_intercept.trusted_ca_choice": [
"trusted_ca_url",
"volterra_trusted_ca"
],
"spec.sli_to_slo_snat.pool_choice": [
"interface_ip"
],
"spec.sli_to_slo_snat.routing_choice": [
"default_gw_snat"
]
}
},
{
"name": "list_network_connectors",
"description": "List Network Connector.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_connectors",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_network_connector",
"description": "DELETE Network Connector.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/network_connectors/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a network_connector",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.network_connector.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for network_connectorDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_connectorDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_network_connector",
"description": "GET Network Connector.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_connectors/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"network-firewalls": {
"name": "network-firewalls",
"displayName": "Network Firewalls",
"operations": [
{
"name": "create_network_firewall",
"description": "Create Network Firewall.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/network_firewalls",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of network_firewall",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.network_firewall.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/network_firewallCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network firewall policy for site-level traffic filtering",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-network-firewall\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-network-firewall\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-network-firewall",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Network firewall policy for site-level traffic filtering"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Network firewall is created by users in system namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies.enhanced_firewall_policies": {
"type": "array",
"description": "Ordered List of Enhanced Firewall Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_fast_acls": {
"type": "object",
"description": "List of Fast ACL(s).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_fast_acls.fast_acls": {
"type": "array",
"description": "Ordered List of Fast ACL(s) active for this network firewall.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies.forward_proxy_policies": {
"type": "array",
"description": "Ordered List of Forward Proxy Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_network_policies.network_policies": {
"type": "array",
"description": "Ordered List of Firewall Policies active for this network firewall.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_fast_acl": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_forward_proxy_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.fast_acl_choice": [
"active_fast_acls",
"disable_fast_acl"
],
"spec.forward_proxy_policy_choice": [
"active_forward_proxy_policies",
"disable_forward_proxy_policy"
],
"spec.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"disable_network_policy"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_network_firewall",
"description": "Replace Network Firewall.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/network_firewalls/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a network_firewall",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.network_firewall.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/network_firewallReplaceSpecType"
}
],
"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": "Network firewall policy for site-level traffic filtering",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-network-firewall\n  namespace: system\nspec: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-network-firewall\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-network-firewall",
"namespace": "system"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Network firewall policy for site-level traffic filtering"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace network firewall will replace the contains of given object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies.enhanced_firewall_policies": {
"type": "array",
"description": "Ordered List of Enhanced Firewall Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_fast_acls": {
"type": "object",
"description": "List of Fast ACL(s).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_fast_acls.fast_acls": {
"type": "array",
"description": "Ordered List of Fast ACL(s) active for this network firewall.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies.forward_proxy_policies": {
"type": "array",
"description": "Ordered List of Forward Proxy Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_network_policies.network_policies": {
"type": "array",
"description": "Ordered List of Firewall Policies active for this network firewall.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_fast_acl": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_forward_proxy_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.fast_acl_choice": [
"active_fast_acls",
"disable_fast_acl"
],
"spec.forward_proxy_policy_choice": [
"active_forward_proxy_policies",
"disable_forward_proxy_policy"
],
"spec.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"disable_network_policy"
]
}
},
{
"name": "list_network_firewalls",
"description": "List Network Firewall.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_firewalls",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_network_firewall",
"description": "DELETE Network Firewall.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/network_firewalls/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a network_firewall",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.network_firewall.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for network_firewallDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_firewallDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_network_firewall",
"description": "GET Network Firewall.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_firewalls/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"network-interfaces": {
"name": "network-interfaces",
"displayName": "Network Interfaces",
"operations": [
{
"name": "create_network_interface",
"description": "Create Network Interface.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/network_interfaces",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of network_interface",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.network_interface.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/network_interfaceCreateSpecType"
}
],
"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 network_interfaceCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_interfaceCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for network_interfaceCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Network interface represents configuration of a network device.\nIt is created by users in system namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface": {
"type": "object",
"description": "Dedicated Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.device": {
"type": "string",
"description": "Name of the device for which interface is configured. Use wwan0 for 4G/LTE.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dedicated_interface.is_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.monitor": {
"type": "object",
"description": "Link Quality Monitoring configuration for a network interface.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.monitor_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.node": {
"type": "string",
"description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node of the site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.not_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.priority": {
"type": "integer",
"description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 255,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface": {
"type": "object",
"description": "Dedicated Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.device": {
"type": "string",
"description": "Name of the device for which interface is configured.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.node": {
"type": "string",
"description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node of the site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface": {
"type": "object",
"description": "Ethernet Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.device": {
"type": "string",
"description": "Interface configuration for the ethernet device.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ethernet_interface.dhcp_client": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.dhcp_server": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.ipv6_auto_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.is_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.monitor": {
"type": "object",
"description": "Link Quality Monitoring configuration for a network interface.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.monitor_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.no_ipv6_address": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.node": {
"type": "string",
"description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.not_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.priority": {
"type": "integer",
"description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 255,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.static_ip": {
"type": "object",
"description": "Configure Static IP parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.static_ipv6_address": {
"type": "object",
"description": "Configure Static IP parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.storage_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.untagged": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.vlan_id": {
"type": "integer",
"description": "Exclusive with [untagged]\nConfigure a VLAN tagged ethernet interface.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 4095,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface": {
"type": "object",
"description": "Layer2 Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface.l2sriov_interface": {
"type": "object",
"description": "Layer2 SR-IOV Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface.l2vlan_interface": {
"type": "object",
"description": "Layer2 VLAN Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface.l2vlan_slo_interface": {
"type": "object",
"description": "Layer2 Site Local Outside VLAN Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface": {
"type": "object",
"description": "Tunnel Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.node": {
"type": "string",
"description": "Exclusive with []\nConfiguration will apply to a given device on the given node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.priority": {
"type": "integer",
"description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 255,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.static_ip": {
"type": "object",
"description": "Configure Static IP parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.tunnel": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.interface_choice": [
"dedicated_interface",
"dedicated_management_interface",
"ethernet_interface",
"layer2_interface",
"tunnel_interface"
],
"spec.dedicated_interface.monitoring_choice": [
"monitor",
"monitor_disabled"
],
"spec.dedicated_interface.node_choice": [
"cluster",
"node"
],
"spec.dedicated_interface.primary_choice": [
"is_primary",
"not_primary"
],
"spec.dedicated_management_interface.node_choice": [
"cluster",
"node"
],
"spec.ethernet_interface.address_choice": [
"dhcp_client",
"dhcp_server",
"static_ip"
],
"spec.ethernet_interface.ipv6_address_choice": [
"ipv6_auto_config",
"no_ipv6_address",
"static_ipv6_address"
],
"spec.ethernet_interface.monitoring_choice": [
"monitor",
"monitor_disabled"
],
"spec.ethernet_interface.network_choice": [
"segment_network",
"site_local_inside_network",
"site_local_network",
"storage_network"
],
"spec.ethernet_interface.node_choice": [
"cluster",
"node"
],
"spec.ethernet_interface.primary_choice": [
"is_primary",
"not_primary"
],
"spec.ethernet_interface.vlan_choice": [
"untagged",
"vlan_id"
],
"spec.ethernet_interface.dhcp_server.interfaces_addressing_choice": [
"automatic_from_end",
"automatic_from_start",
"interface_ip_map"
],
"spec.ethernet_interface.ipv6_auto_config.autoconfig_choice": [
"host",
"router"
],
"spec.ethernet_interface.static_ip.network_prefix_choice": [
"cluster_static_ip",
"node_static_ip"
],
"spec.ethernet_interface.static_ipv6_address.network_prefix_choice": [
"cluster_static_ip",
"node_static_ip"
],
"spec.layer2_interface.layer2_interface_choice": [
"l2sriov_interface",
"l2vlan_interface",
"l2vlan_slo_interface"
],
"spec.layer2_interface.l2sriov_interface.vlan_choice": [
"untagged",
"vlan_id"
],
"spec.tunnel_interface.network_choice": [
"site_local_inside_network",
"site_local_network"
],
"spec.tunnel_interface.node_choice": [
"node"
],
"spec.tunnel_interface.static_ip.network_prefix_choice": [
"cluster_static_ip",
"node_static_ip"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_network_interface",
"description": "Replace Network Interface.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/network_interfaces/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a network_interface",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.network_interface.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/network_interfaceReplaceSpecType"
}
],
"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 network_interfaceReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_interfaceReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for network_interfaceReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface": {
"type": "object",
"description": "Dedicated Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.device": {
"type": "string",
"description": "Name of the device for which interface is configured. Use wwan0 for 4G/LTE.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dedicated_interface.is_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.monitor": {
"type": "object",
"description": "Link Quality Monitoring configuration for a network interface.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.monitor_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.node": {
"type": "string",
"description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node of the site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.not_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_interface.priority": {
"type": "integer",
"description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 255,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface": {
"type": "object",
"description": "Dedicated Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.device": {
"type": "string",
"description": "Name of the device for which interface is configured.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dedicated_management_interface.node": {
"type": "string",
"description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node of the site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface": {
"type": "object",
"description": "Ethernet Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.device": {
"type": "string",
"description": "Interface configuration for the ethernet device.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ethernet_interface.dhcp_client": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.dhcp_server": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.ipv6_auto_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.is_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.monitor": {
"type": "object",
"description": "Link Quality Monitoring configuration for a network interface.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.monitor_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.no_ipv6_address": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.node": {
"type": "string",
"description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.not_primary": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.priority": {
"type": "integer",
"description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 255,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.static_ip": {
"type": "object",
"description": "Configure Static IP parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.static_ipv6_address": {
"type": "object",
"description": "Configure Static IP parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.storage_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.untagged": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ethernet_interface.vlan_id": {
"type": "integer",
"description": "Exclusive with [untagged]\nConfigure a VLAN tagged ethernet interface.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 4095,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface": {
"type": "object",
"description": "Layer2 Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface.l2sriov_interface": {
"type": "object",
"description": "Layer2 SR-IOV Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface.l2vlan_interface": {
"type": "object",
"description": "Layer2 VLAN Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.layer2_interface.l2vlan_slo_interface": {
"type": "object",
"description": "Layer2 Site Local Outside VLAN Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface": {
"type": "object",
"description": "Tunnel Interface Configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.mtu": {
"type": "integer",
"description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16384,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.node": {
"type": "string",
"description": "Exclusive with []\nConfiguration will apply to a given device on the given node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.priority": {
"type": "integer",
"description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 255,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.static_ip": {
"type": "object",
"description": "Configure Static IP parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_interface.tunnel": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.interface_choice": [
"dedicated_interface",
"dedicated_management_interface",
"ethernet_interface",
"layer2_interface",
"tunnel_interface"
],
"spec.dedicated_interface.monitoring_choice": [
"monitor",
"monitor_disabled"
],
"spec.dedicated_interface.node_choice": [
"cluster",
"node"
],
"spec.dedicated_interface.primary_choice": [
"is_primary",
"not_primary"
],
"spec.dedicated_management_interface.node_choice": [
"cluster",
"node"
],
"spec.ethernet_interface.address_choice": [
"dhcp_client",
"dhcp_server",
"static_ip"
],
"spec.ethernet_interface.ipv6_address_choice": [
"ipv6_auto_config",
"no_ipv6_address",
"static_ipv6_address"
],
"spec.ethernet_interface.monitoring_choice": [
"monitor",
"monitor_disabled"
],
"spec.ethernet_interface.network_choice": [
"segment_network",
"site_local_inside_network",
"site_local_network",
"storage_network"
],
"spec.ethernet_interface.node_choice": [
"cluster",
"node"
],
"spec.ethernet_interface.primary_choice": [
"is_primary",
"not_primary"
],
"spec.ethernet_interface.vlan_choice": [
"untagged",
"vlan_id"
],
"spec.ethernet_interface.dhcp_server.interfaces_addressing_choice": [
"automatic_from_end",
"automatic_from_start",
"interface_ip_map"
],
"spec.ethernet_interface.ipv6_auto_config.autoconfig_choice": [
"host",
"router"
],
"spec.ethernet_interface.static_ip.network_prefix_choice": [
"cluster_static_ip",
"node_static_ip"
],
"spec.ethernet_interface.static_ipv6_address.network_prefix_choice": [
"cluster_static_ip",
"node_static_ip"
],
"spec.layer2_interface.layer2_interface_choice": [
"l2sriov_interface",
"l2vlan_interface",
"l2vlan_slo_interface"
],
"spec.layer2_interface.l2sriov_interface.vlan_choice": [
"untagged",
"vlan_id"
],
"spec.tunnel_interface.network_choice": [
"site_local_inside_network",
"site_local_network"
],
"spec.tunnel_interface.node_choice": [
"node"
],
"spec.tunnel_interface.static_ip.network_prefix_choice": [
"cluster_static_ip",
"node_static_ip"
]
}
},
{
"name": "list_network_interfaces",
"description": "List Network Interface.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_interfaces",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_network_interface",
"description": "DELETE Network Interface.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/network_interfaces/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a network_interface",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.network_interface.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for network_interfaceDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_interfaceDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
}
},
{
"name": "get_network_interface",
"description": "GET Network Interface.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_interfaces/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"network-policy-rules": {
"name": "network-policy-rules",
"displayName": "Network Policy Rules",
"operations": [
{
"name": "create_network_policy_rule",
"description": "Create Network Policy Rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/network_policy_rules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of network_policy_rule",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.network_policy_rule.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/network_policy_ruleCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network-level access control policy for site and namespace traffic",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"mutually_exclusive_groups": [
{
"name": "endpoint_choice",
"fields": [
"spec.endpoint.any",
"spec.endpoint.inside_endpoints",
"spec.endpoint.label_selector",
"spec.endpoint.outside_endpoints",
"spec.endpoint.prefix_list"
],
"required": true,
"reason": "Choose endpoint matching strategy (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-np\n  namespace: default\nspec:\n  endpoint:\n    any: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-np\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endpoint\": {\"any\": {}}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-np",
"namespace": "default"
},
"spec": {
"endpoint": {
"any": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"description": "Network-level access control policy for site and namespace traffic"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a network policy rule with configured parameters in specified namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "Network policy rule action configures the action to be taken on rule match\n\nApply deny action on rule match\nApply allow action on rule match.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.advanced_action": {
"type": "object",
"description": "Network Policy Rule Advanced Action provides additional OPTIONS along with RuleAction and PBRRuleAction.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_action.action": {
"type": "string",
"description": "Choice to choose logging or no logging\nThis works together with option selected via NetworkPolicyRuleAction or any other action specified\nx-example: (No Selection in NetworkPolicyRuleAction + AdvancedAction as LOG) = LOG Only, (ALLOW/DENY in NetworkPolicyRuleAction + AdvancedAction as LOG) = Log and Allow/Deny, (ALLOW/DENY in NetworkPolicyRuleAction + NOLOG in AdvancedAction) = Allow/Deny with no log\n\nDon't sample the traffic hitting the rule\nSample the traffic hitting the rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "NOLOG"
},
"spec.ip_prefix_set": {
"type": "object",
"description": "A list of references to ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_set.ref": {
"type": "array",
"description": "A list of references to ip_prefix_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher": {
"type": "object",
"description": "A label matcher specifies a list of label keys whose values need to match for\nsource/client and destination/server. Note that the actual label values are not\nspecified and do not matter. This allows an ability to scope grouping by the\nlabel key name.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher.keys": {
      "type": "array",
"description": "The list of label key names that have to match.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ports": {
"type": "array",
"description": "List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Protocol in IP packet to be used as match criteria\nValues are TCP, UDP, and icmp.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.remote_endpoint": [
"ip_prefix_set",
"prefix",
"prefix_selector"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_network_policy_rule",
"description": "Replace Network Policy Rule.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/network_policy_rules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a network_policy_rule",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.network_policy_rule.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/network_policy_ruleReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network-level access control policy for site and namespace traffic",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"mutually_exclusive_groups": [
{
"name": "endpoint_choice",
"fields": [
"spec.endpoint.any",
"spec.endpoint.inside_endpoints",
"spec.endpoint.label_selector",
"spec.endpoint.outside_endpoints",
"spec.endpoint.prefix_list"
],
"required": true,
"reason": "Choose endpoint matching strategy (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-np\n  namespace: default\nspec:\n  endpoint:\n    any: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-np\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endpoint\": {\"any\": {}}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-np",
"namespace": "default"
},
"spec": {
"endpoint": {
"any": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"description": "Network-level access control policy for site and namespace traffic"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces a network policy rule with configured parameters in specified namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "Network policy rule action configures the action to be taken on rule match\n\nApply deny action on rule match\nApply allow action on rule match.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.advanced_action": {
"type": "object",
"description": "Network Policy Rule Advanced Action provides additional OPTIONS along with RuleAction and PBRRuleAction.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_action.action": {
"type": "string",
"description": "Choice to choose logging or no logging\nThis works together with option selected via NetworkPolicyRuleAction or any other action specified\nx-example: (No Selection in NetworkPolicyRuleAction + AdvancedAction as LOG) = LOG Only, (ALLOW/DENY in NetworkPolicyRuleAction + AdvancedAction as LOG) = Log and Allow/Deny, (ALLOW/DENY in NetworkPolicyRuleAction + NOLOG in AdvancedAction) = Allow/Deny with no log\n\nDon't sample the traffic hitting the rule\nSample the traffic hitting the rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "NOLOG"
},
"spec.ip_prefix_set": {
"type": "object",
"description": "A list of references to ip_prefix_set objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_set.ref": {
"type": "array",
"description": "A list of references to ip_prefix_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher": {
"type": "object",
"description": "A label matcher specifies a list of label keys whose values need to match for\nsource/client and destination/server. Note that the actual label values are not\nspecified and do not matter. This allows an ability to scope grouping by the\nlabel key name.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher.keys": {
      "type": "array",
"description": "The list of label key names that have to match.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ports": {
"type": "array",
"description": "List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.prefix_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Protocol in IP packet to be used as match criteria\nValues are TCP, UDP, and icmp.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.remote_endpoint": [
"ip_prefix_set",
"prefix",
"prefix_selector"
]
}
},
{
"name": "list_network_policy_rules",
"description": "List Network Policy Rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policy_rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_network_policy_rule",
"description": "DELETE Network Policy Rule.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/network_policy_rules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a network_policy_rule",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.network_policy_rule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for network_policy_ruleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_policy_ruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_network_policy_rule",
"description": "GET Network Policy Rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policy_rules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"network-policy-sets": {
"name": "network-policy-sets",
"displayName": "Network Policy Sets",
"operations": [
{
"name": "list_network_policy_sets",
"description": "List Network Policy Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policy_sets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_network_policy_set",
"description": "GET Network Policy Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policy_sets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"network-policy-views": {
"name": "network-policy-views",
"displayName": "Network Policy Views",
"operations": [
{
"name": "create_network_policy_view",
"description": "Create Network policy View.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/network_policy_views",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of network_policy_view",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.network_policy_view.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/viewsnetwork_policy_viewCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network-level access control policy for site and namespace traffic",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"mutually_exclusive_groups": [
{
"name": "endpoint_choice",
"fields": [
"spec.endpoint.any",
"spec.endpoint.inside_endpoints",
"spec.endpoint.label_selector",
"spec.endpoint.outside_endpoints",
"spec.endpoint.prefix_list"
],
"required": true,
"reason": "Choose endpoint matching strategy (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-np\n  namespace: default\nspec:\n  endpoint:\n    any: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-np\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endpoint\": {\"any\": {}}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-np",
"namespace": "default"
},
"spec": {
"endpoint": {
"any": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"description": "Network-level access control policy for site and namespace traffic"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Network policy view specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.egress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections from policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint": {
"type": "object",
"description": "Shape of the endpoint choices for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.inside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.outside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections to policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.endpoint.endpoint_choice": [
"any",
"inside_endpoints",
"label_selector",
"outside_endpoints",
"prefix_list"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_network_policy_view",
"description": "Replace Network policy View.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/network_policy_views/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a network_policy_view",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.network_policy_view.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsnetwork_policy_viewReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network-level access control policy for site and namespace traffic",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"mutually_exclusive_groups": [
{
"name": "endpoint_choice",
"fields": [
"spec.endpoint.any",
"spec.endpoint.inside_endpoints",
"spec.endpoint.label_selector",
"spec.endpoint.outside_endpoints",
"spec.endpoint.prefix_list"
],
"required": true,
"reason": "Choose endpoint matching strategy (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-np\n  namespace: default\nspec:\n  endpoint:\n    any: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-np\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endpoint\": {\"any\": {}}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-np",
"namespace": "default"
},
"spec": {
"endpoint": {
"any": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"description": "Network-level access control policy for site and namespace traffic"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Network policy view replace specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.egress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections from policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint": {
"type": "object",
"description": "Shape of the endpoint choices for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.inside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.outside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ingress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections to policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.endpoint.endpoint_choice": [
"any",
"inside_endpoints",
"label_selector",
"outside_endpoints",
"prefix_list"
]
}
},
{
"name": "list_network_policy_views",
"description": "List Configure Network policy View.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policy_views",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_network_policy_view",
"description": "DELETE Configure Network policy View.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/network_policy_views/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a network_policy_view",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.network_policy_view.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for network_policy_viewDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_policy_viewDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_network_policy_view",
"description": "GET Network policy View.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policy_views/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"network-policys": {
"name": "network-policys",
"displayName": "Network Policys",
"operations": [
{
"name": "create_network_policy",
"description": "Create Network Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/network_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of network_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.network_policy.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/schemanetwork_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network-level access control policy for site and namespace traffic",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"mutually_exclusive_groups": [
{
"name": "endpoint_choice",
"fields": [
"spec.endpoint.any",
"spec.endpoint.inside_endpoints",
"spec.endpoint.label_selector",
"spec.endpoint.outside_endpoints",
"spec.endpoint.prefix_list"
],
"required": true,
"reason": "Choose endpoint matching strategy (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-np\n  namespace: default\nspec:\n  endpoint:\n    any: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-np\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endpoint\": {\"any\": {}}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-np",
"namespace": "default"
},
"spec": {
"endpoint": {
"any": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"description": "Network-level access control policy for site and namespace traffic"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new network policy with configured parameters in specified namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.endpoint": {
"type": "object",
"description": "Shape of the endpoint choices for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.inside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.outside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "object",
"description": "Shape of Rule Choice.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules.egress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections from policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules.ingress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections to policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.endpoint.endpoint_choice": [
"any",
"inside_endpoints",
"label_selector",
"outside_endpoints",
"prefix_list"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_network_policy",
"description": "Replace Network Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/network_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a network_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.network_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemanetwork_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Network-level access control policy for site and namespace traffic",
      "required_fields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"mutually_exclusive_groups": [
{
"name": "endpoint_choice",
"fields": [
"spec.endpoint.any",
"spec.endpoint.inside_endpoints",
"spec.endpoint.label_selector",
"spec.endpoint.outside_endpoints",
"spec.endpoint.prefix_list"
],
"required": true,
"reason": "Choose endpoint matching strategy (REQUIRED)"
}
],
"example_yaml": "metadata:\n  name: example-np\n  namespace: default\nspec:\n  endpoint:\n    any: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-np\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endpoint\": {\"any\": {}}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-np",
"namespace": "default"
},
"spec": {
"endpoint": {
"any": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.endpoint"
],
"description": "Network-level access control policy for site and namespace traffic"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces configured Network Policy with new set of parameters in specified namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.endpoint": {
"type": "object",
"description": "Shape of the endpoint choices for a view.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.inside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.outside_endpoints": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "object",
"description": "Shape of Rule Choice.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules.egress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections from policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules.ingress_rules": {
"type": "array",
"description": "Ordered list of rules applied to connections to policy endpoints.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.endpoint.endpoint_choice": [
"any",
"inside_endpoints",
"label_selector",
"outside_endpoints",
"prefix_list"
]
}
},
{
"name": "list_network_policys",
"description": "List Network Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_network_policy",
"description": "DELETE Network Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/network_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a network_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.network_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for network_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for network_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_network_policy",
"description": "GET Network Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/network_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"networking-inventory": {
"name": "networking-inventory",
"displayName": "Networking Inventory",
"operations": [
{
"name": "create_networking_inventory",
"description": "Networking Objects Inventory.",
"method": "POST",
"path": "/api/config/namespaces/system/networking_inventory",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for inventory of networking related objects.",
"title": "NetworkingInventoryRequest",
"x-displayname": "Networking related objects inventory request.",
"x-ves-proto-message": "ves.io.schema.namespace.NetworkingInventoryRequest",
"x-f5xc-description-short": "Request for inventory of networking related objects.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceNetworkingInventoryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceNetworkingInventoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"cloud_links": {
"type": "integer"
},
"dc_cluster_groups": {
"type": "integer"
},
"global_networks": {
"type": "integer"
},
"segments": {
"type": "integer"
},
"site_mesh_groups": {
"type": "integer"
},
"sites": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceNetworkingInventoryRequest"
},
"responseSummary": [
{
"field": "cloud_links",
"type": "integer",
"description": "Number of CloudLinks."
},
{
"field": "dc_cluster_groups",
"type": "integer",
"description": "Number of DC cluster groups configured."
},
{
"field": "global_networks",
"type": "integer",
"description": "Number of global networks configured."
},
{
"field": "segments",
"type": "integer",
"description": "Number of Segments."
},
{
"field": "site_mesh_groups",
"type": "integer",
"description": "Number of site mesh groups configured."
},
{
"field": "sites",
"type": "integer",
"description": "Number of sites configured."
}
]
}
]
},
	"nfv-service-force-delete": {
"name": "nfv-service-force-delete",
"displayName": "Nfv Service Force Delete",
"operations": [
{
"name": "create_nfv_service_force_delete",
"description": "Force DELETE NFV Service.",
"method": "POST",
"path": "/api/config/namespaces/system/nfv_service/{name}/force-delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Force DELETE NFV Service Request.",
"title": "ForceDeleteNFVServiceRequest",
"x-displayname": "Force DELETE NFV Service Request.",
"x-ves-proto-message": "ves.io.schema.nfv_service.ForceDeleteNFVServiceRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the NFV object to be force deleted.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Nfv-service-1.",
"x-f5xc-example": "nfv-service-1",
"x-f5xc-description-short": "Name of the NFV object to be force deleted.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nfv_serviceForceDeleteNFVServiceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nfv_serviceForceDeleteNFVServiceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nfv_serviceForceDeleteNFVServiceRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the NFV object to be force deleted.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"nfv-services": {
"name": "nfv-services",
"displayName": "Nfv Services",
"operations": [
{
"name": "create_nfv_service",
"description": "Create NFV Service.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/nfv_services",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of nfv_service",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.nfv_service.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/schemanfv_serviceCreateSpecType"
}
],
"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 nfv_serviceCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nfv_serviceCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nfv_serviceCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new NFV service with configured parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_https_management": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ssh_access": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access": {
      "type": "object",
"description": "SSH based configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.advertise_on_sli": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.advertise_on_slo": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.advertise_on_slo_sli": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.domain_suffix": {
      "type": "string",
"description": "Domain suffix will be used along with node name to form the hostname for SSH node management.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.node_ssh_ports": {
      "type": "array",
"description": "Enter TCP port and node name per node.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 2,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service": {
"type": "object",
"description": "Virtual BIG-IP specification for AWS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.admin_username": {
"type": "string",
"description": "Admin Username for BIG-IP.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.aws_tgw_site_params": {
"type": "object",
"description": "BIG-IP AWS TGW site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.endpoint_service": {
"type": "object",
"description": "Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with\na new destination address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.market_place_image": {
"type": "object",
"description": "BIG-IP AWS Pay as You Go Image Selection.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.nodes": {
"type": "array",
"description": "Specify how and where the service nodes are spawned.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 2,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.ssh_key": {
      "type": "string",
"description": "Public SSH key for accessing the Big IP nodes.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.tags": {
"type": "object",
"description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management": {
"type": "object",
"description": "HTTPS based configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_internet": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_internet_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_sli_vip": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_slo_internet_vip": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_slo_sli": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_slo_vip": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.default_https_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.domain_suffix": {
"type": "string",
"description": "Domain suffix will be used along with node name to form URL to access node management.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.https_management.https_port": {
"type": "integer",
"description": "Exclusive with [default_https_port]\nEnter TCP port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service": {
"type": "object",
"description": "Palo Alto Networks VM-Series next-generation firewall configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.auto_setup": {
"type": "object",
"description": "For auto-setup, SSH public and pvt keys are needed.\nUsing the given config user, SSH and API access will be configured.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.aws_tgw_site": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.disable_panaroma": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.instance_type": {
"type": "string",
"description": "- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_XLARGE: m4.xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_2XLARGE: m4.2xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_4XLARGE: m4.4xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_LARGE: m5.large\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_XLARGE: m5.xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_2XLARGE: m5.2xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_4XLARGE: m5.4xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_12XLARGE: m5.12xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_LARGE: m5n.large\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_XLARGE: m5n.xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_2XLARGE: m5n.2xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_4XLARGE: m5n.4xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_LARGE: c4.large\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_XLARGE: c4.xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_2XLARGE: c4.2xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_4XLARGE: c4.4xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_8XLARGE: c4.8xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_LARGE: c5.large\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_XLARGE: c5.xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_2XLARGE: c5.2xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_4XLARGE: c5.4xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_9XLARGE: c5.9xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_18XLARGE: c5.18xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_LARGE: c5n.large\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_XLARGE: c5n.xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_2XLARGE: c5n.2xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_4XLARGE: c5n.4xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_9XLARGE: c5n.9xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_18XLARGE: c5n.18xlarge\n\n- PALO_ALTO_FW_AWS_INSTANCE_TYPE_R5_2XLARGE: r5.2xlarge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_XLARGE"
},
"spec.palo_alto_fw_service.pan_ami_bundle1": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.pan_ami_bundle2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.panorama_server": {
"type": "object",
"description": "Panorama Server Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.service_nodes": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.ssh_key": {
      "type": "string",
"description": "Exclusive with [auto_setup]\nSetup Authorized Public SSH key. User will be able to SSH to the vmseries nodes using\nits corresponding SSH private key.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.tags": {
"type": "object",
"description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.version": {
"type": "string",
"description": "PAN-OS version.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.http_management_choice": [
"disable_https_management",
"https_management"
],
"spec.service_provider_choice": [
"f5_big_ip_aws_service",
"palo_alto_fw_service"
],
"spec.ssh_management_choice": [
"disable_ssh_access",
      "enabled_ssh_access"
      ],
"spec.enabled_ssh_access.advertise_choice": [
      "advertise_on_sli",
"advertise_on_slo",
"advertise_on_slo_sli"
],
"spec.f5_big_ip_aws_service.image_choice": [
"market_place_image"
],
"spec.f5_big_ip_aws_service.site_type_choice": [
"aws_tgw_site_params"
],
"spec.f5_big_ip_aws_service.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.f5_big_ip_aws_service.endpoint_service.external_vip_choice": [
"advertise_on_slo_ip",
"advertise_on_slo_ip_external",
"disable_advertise_on_slo_ip"
],
"spec.f5_big_ip_aws_service.endpoint_service.inside_vip_choice": [
"automatic_vip",
"configured_vip"
],
"spec.f5_big_ip_aws_service.endpoint_service.tcp_port_choice": [
"custom_tcp_ports",
"default_tcp_ports",
"http_port",
"https_port",
"no_tcp_ports"
],
"spec.f5_big_ip_aws_service.endpoint_service.udp_port_choice": [
"custom_udp_ports",
"no_udp_ports"
],
"spec.f5_big_ip_aws_service.market_place_image.ami_choice": [
"AWAFPayG200Mbps",
"AWAFPayG3Gbps",
"BestPlusPayG200Mbps",
"best_plus_payg_1gbps"
],
"spec.https_management.advertise_choice": [
"advertise_on_internet",
"advertise_on_internet_default_vip",
"advertise_on_sli_vip",
"advertise_on_slo_internet_vip",
"advertise_on_slo_sli",
"advertise_on_slo_vip"
],
"spec.https_management.internet_choice": [],
"spec.https_management.port_choice": [
"default_https_port",
"https_port"
],
"spec.https_management.advertise_on_sli_vip.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_management.advertise_on_slo_internet_vip.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_management.advertise_on_slo_sli.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_management.advertise_on_slo_vip.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.palo_alto_fw_service.ami_choice": [
"pan_ami_bundle1",
"pan_ami_bundle2"
],
"spec.palo_alto_fw_service.panaroma_connection": [
"disable_panaroma",
"panorama_server"
],
"spec.palo_alto_fw_service.setup_options": [
"auto_setup",
"ssh_key"
      ],
"spec.palo_alto_fw_service.auto_setup.ssh_keys_choice": [
      "manual_ssh_keys"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_nfv_service",
"description": "Replace NFV Service.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/nfv_services/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a nfv_service",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.nfv_service.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/schemanfv_serviceReplaceSpecType"
}
],
"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 nfv_serviceReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nfv_serviceReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nfv_serviceReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces configured NFV Service with new set of parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_https_management": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ssh_access": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access": {
      "type": "object",
"description": "SSH based configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.advertise_on_sli": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.advertise_on_slo": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.advertise_on_slo_sli": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.domain_suffix": {
      "type": "string",
"description": "Domain suffix will be used along with node name to form the hostname for SSH node management.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enabled_ssh_access.node_ssh_ports": {
      "type": "array",
"description": "Enter TCP port and node name per node.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 2,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service": {
"type": "object",
"description": "Virtual BIG-IP specification for AWS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.endpoint_service": {
"type": "object",
"description": "Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with\na new destination address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_big_ip_aws_service.tags": {
"type": "object",
"description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management": {
"type": "object",
"description": "HTTPS based configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_internet": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_internet_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_sli_vip": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_slo_internet_vip": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_slo_sli": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.advertise_on_slo_vip": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.default_https_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.https_management.domain_suffix": {
"type": "string",
"description": "Domain suffix will be used along with node name to form URL to access node management.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.https_management.https_port": {
"type": "integer",
"description": "Exclusive with [default_https_port]\nEnter TCP port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service": {
"type": "object",
"description": "Virtual PaloAlto Firewall specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.palo_alto_fw_service.tags": {
"type": "object",
"description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.http_management_choice": [
"disable_https_management",
"https_management"
],
"spec.service_provider_choice": [
"f5_big_ip_aws_service",
"palo_alto_fw_service"
],
"spec.ssh_management_choice": [
"disable_ssh_access",
      "enabled_ssh_access"
      ],
"spec.enabled_ssh_access.advertise_choice": [
      "advertise_on_sli",
"advertise_on_slo",
"advertise_on_slo_sli"
],
"spec.f5_big_ip_aws_service.endpoint_service.external_vip_choice": [
"advertise_on_slo_ip",
"advertise_on_slo_ip_external",
"disable_advertise_on_slo_ip"
],
"spec.f5_big_ip_aws_service.endpoint_service.tcp_port_choice": [
"custom_tcp_ports",
"default_tcp_ports",
"http_port",
"https_port",
"no_tcp_ports"
],
"spec.f5_big_ip_aws_service.endpoint_service.udp_port_choice": [
"custom_udp_ports",
"no_udp_ports"
],
"spec.https_management.advertise_choice": [
"advertise_on_internet",
"advertise_on_internet_default_vip",
"advertise_on_sli_vip",
"advertise_on_slo_internet_vip",
"advertise_on_slo_sli",
"advertise_on_slo_vip"
],
"spec.https_management.internet_choice": [],
"spec.https_management.port_choice": [
"default_https_port",
"https_port"
],
"spec.https_management.advertise_on_sli_vip.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_management.advertise_on_slo_internet_vip.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_management.advertise_on_slo_sli.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.https_management.advertise_on_slo_vip.mtls_choice": [
"no_mtls",
"use_mtls"
]
}
},
{
"name": "list_nfv_services",
"description": "List NFV Service.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nfv_services",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_nfv_service",
"description": "DELETE NFV Service.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/nfv_services/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a nfv_service",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.nfv_service.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nfv_serviceDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nfv_serviceDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
}
},
{
"name": "get_nfv_service",
"description": "GET NFV Service.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nfv_services/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"nginx-csgs": {
"name": "nginx-csgs",
"displayName": "Nginx Csgs",
"operations": [
{
"name": "list_nginx_csgs",
"description": "List NGINX One CSG Object configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_csgs",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_nginx_csg",
"description": "GET Request.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_csgs/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"nginx-dataplane-servers": {
"name": "nginx-dataplane-servers",
"displayName": "Nginx Dataplane Servers",
"operations": [
{
"name": "create_nginx_dataplane_server",
"description": "GET NGINX One Dataplane Servers.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/nginx_dataplane_servers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET NGINX One Dataplane servers request.",
"title": "Get NGINX One Dataplane servers request",
"x-displayname": "GET NGINX One Dataplane servers request.",
"x-ves-proto-message": "ves.io.schema.nginx.one.nginx_server.GetDataplaneServersRequest",
"properties": {
"dataplane_ref": {
"allOf": [
{
"$ref": "#/components/schemas/nginx_serverDataplaneReference"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the NGINX One Instance.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "GET NGINX One Dataplane servers request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nginx_serverGetDataplaneServersRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nginx_serverGetDataplaneServersRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "nginx_one"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nginx_serverGetDataplaneServersRequest"
},
"fieldMetadata": {
"dataplane_ref": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_csg": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_csg.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_csg.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_csg.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_instance": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_instance.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_instance.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dataplane_ref.nginx_instance.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the NGINX One Instance.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"dataplane_ref.dataplane_ref": [
"nginx_csg",
"nginx_instance"
]
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "The NGINX One Servers associated to the dataplane."
}
]
}
]
},
	"nginx-instances": {
"name": "nginx-instances",
"displayName": "Nginx Instances",
"operations": [
{
"name": "list_nginx_instances",
"description": "List NGINX One Instance Object configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_instances",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_nginx_instance",
"description": "GET Request.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_instances/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"nginx-one-n1-subscribe": {
"name": "nginx-one-n1-subscribe",
"displayName": "Nginx One N1 Subscribe",
"operations": [
{
"name": "create_nginx_one_n1_subscribe",
"description": "Subscribe to NGINX One.",
"method": "POST",
"path": "/api/nginx/one/namespaces/system/n1/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to NGINX One.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.nginx.one.subscription.SubscribeRequest",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"nginx-one-n1-unsubscribe": {
"name": "nginx-one-n1-unsubscribe",
"displayName": "Nginx One N1 Unsubscribe",
"operations": [
{
"name": "create_nginx_one_n1_unsubscribe",
"description": "Unsubscribe to NGINX One.",
"method": "POST",
"path": "/api/nginx/one/namespaces/system/n1/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to NGINX One.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.nginx.one.subscription.UnsubscribeRequest",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"nginx-servers": {
"name": "nginx-servers",
"displayName": "Nginx Servers",
"operations": [
{
"name": "list_nginx_servers",
"description": "List NGINX One Server APIs.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_servers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_nginx_server",
"description": "GET Request.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_servers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"nginx-service-discoverys": {
"name": "nginx-service-discoverys",
"displayName": "Nginx Service Discoverys",
"operations": [
{
"name": "create_nginx_service_discovery",
"description": "Create NGINX Service Discovery.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/nginx_service_discoverys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of nginx_service_discovery",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.nginx.one.nginx_service_discovery.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/nginx_service_discoveryCreateSpecType"
}
],
"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 nginx_service_discoveryCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nginx_service_discoveryCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "nginx_one"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nginx_service_discoveryCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to create NGINX Service Discovery object for a site or virtual site in system namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_target": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_target.config_sync_group": {
"type": "object",
"description": "Select new ConfigSyncGroup.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_target.nginx_instance": {
"type": "object",
"description": "Select new NGINX Instance.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_block_filters": {
"type": "array",
"description": "Filters discovered server blocks based on server name, domain and ports.\nAtleast, one field should be populated for each filter.\n\nX-textBlockContent:\nIf no filters are specified, all server blocks will be discovered by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 10,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.discovery_target.target": [
"config_sync_group",
"nginx_instance"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_nginx_service_discovery",
"description": "Replace NGINX Service Discovery.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/nginx_service_discoverys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a nginx_service_discovery",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.nginx.one.nginx_service_discovery.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/nginx_service_discoveryReplaceSpecType"
}
],
"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 nginx_service_discoveryReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nginx_service_discoveryReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "nginx_one"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for nginx_service_discoveryReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "API to replace NGINX Service Discovery object for a site or virtual site in system namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_target": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_target.config_sync_group": {
"type": "object",
"description": "Select new ConfigSyncGroup.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.discovery_target.nginx_instance": {
"type": "object",
"description": "Select new NGINX Instance.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_block_filters": {
"type": "array",
"description": "Filters discovered server blocks based on server name, domain and ports.\nAtleast, one field should be populated for each filter.\n\nX-textBlockContent:\nIf no filters are specified, all server blocks will be discovered by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 10,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.discovery_target.target": [
"config_sync_group",
"nginx_instance"
]
}
},
{
"name": "list_nginx_service_discoverys",
"description": "List NGINX Service Discovery.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_service_discoverys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_nginx_service_discovery",
"description": "DELETE NGINX Service Discovery.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/nginx_service_discoverys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a nginx_service_discovery",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.nginx.one.nginx_service_discovery.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for nginx_service_discoveryDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for nginx_service_discoveryDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "nginx_one"
}
},
{
"name": "get_nginx_service_discovery",
"description": "GET NGINX Service Discovery.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/nginx_service_discoverys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"no-auth-aws-f5xc-saas-register": {
"name": "no-auth-aws-f5xc-saas-register",
      "displayName": "No Auth Aws F5Xc Saas Register",
      "operations": [
{
"name": "create_no_auth_aws_f5xc_saas_register",
      "description": "Register New AWS Account.",
"method": "POST",
"path": "/no_auth/namespaces/system/aws/f5xc-saas/register",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to register F5XC AWS marketplace product for F5XC service.",
"title": "RegistrationRequest",
"x-displayname": "AWS SaaS PAYG Registration Request.",
"x-ves-proto-message": "ves.io.schema.marketplace.aws_account.RegistrationRequest",
"properties": {
"x_amzn_marketplace_token": {
      "type": "string",
"description": "AWS customer’s registration token.",
      "title": "x-amzn-marketplace-token",
      "x-displayname": "X-amzn-marketplace-token.",
      "x-ves-example": "X-amzn-marketplace-token=<token val>",
      "x-f5xc-example": "x-amzn-marketplace-token=<token val>",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to register F5XC AWS marketplace product for F5XC service.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_accountRegistrationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_accountRegistrationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {
"redirect_url": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_accountRegistrationRequest"
},
"fieldMetadata": {
"x_amzn_marketplace_token": {
      "type": "string",
"description": "AWS customer’s registration token.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "redirect_url",
"type": "string",
"description": "Registration redirect URL for redirecting the AWS customer to login/registration page."
}
]
}
]
},
	"no-auth-aws-f5xc-saas-signup": {
"name": "no-auth-aws-f5xc-saas-signup",
      "displayName": "No Auth Aws F5Xc Saas Signup",
      "operations": [
{
"name": "create_no_auth_aws_f5xc_saas_signup",
      "description": "Signup AWS Account.",
"method": "POST",
"path": "/no_auth/namespaces/system/aws/f5xc-saas/signup",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "AWSAccountSignupRequest",
"x-displayname": "AWS Account Signup Request.",
"x-ves-proto-message": "ves.io.schema.marketplace.aws_account.AWSAccountSignupRequest",
"properties": {
"account_details": {
"allOf": [
{
"$ref": "#/components/schemas/signupAccountMeta"
}
],
"x-f5xc-description-short": "Configuration parameter for account details.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"account_id": {
"type": "string",
"description": "Identifier for the aws_account object.",
"title": "account_id",
"x-displayname": "Account ID.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"company_details": {
"allOf": [
{
"$ref": "#/components/schemas/signupCompanyMeta"
}
],
"x-f5xc-description-short": "Configuration parameter for company details.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"crm_details": {
"allOf": [
{
"$ref": "#/components/schemas/schemaCRMInfo"
}
],
"x-f5xc-description-short": "Configuration parameter for crm details.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_details": {
"allOf": [
{
"$ref": "#/components/schemas/signupUserMeta"
}
],
"x-f5xc-description-short": "Configuration parameter for user details.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_accountAWSAccountSignupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_accountAWSAccountSignupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_accountAWSAccountSignupRequest"
},
"fieldMetadata": {
"account_details": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"account_details.domain": {
"type": "string",
"description": "Domain of the account.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 17,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"account_details.locale": {
"type": "string",
"description": "Locale of the account.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"account_details.tos_accepted_at": {
"type": "string",
"description": "Terms of services accepted timestamp.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"account_details.tos_version": {
"type": "string",
"description": "Terms of services version.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 12,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"account_id": {
"type": "string",
"description": "Identifier for the aws_account object.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.address1": {
"type": "string",
"description": "Address line 1.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.address2": {
"type": "string",
"description": "Address line 2.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.city": {
"type": "string",
"description": "City / town of the contact.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.country": {
"type": "string",
"description": "Country of contact (e.g. USA). Refer to https://en.wikipedia.org/wiki/ISO_3166-1, column alpha-2.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.county": {
"type": "string",
"description": "County (optional, for countries where they have counties)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.phone_number": {
"type": "string",
"description": "Phone number of the contact.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.state": {
"type": "string",
"description": "State (optional, for countries where they have states)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.state_code": {
"type": "string",
"description": "State code (optional, for countries where they have states)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.mailing_address.zip_code": {
"type": "string",
"description": "Zip or postal code.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"company_details.name": {
"type": "string",
"description": "Name of the company.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"crm_details": {
"type": "object",
"description": "CRM Information.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_details": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_details.contact_number": {
"type": "string",
"description": "Contact number of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_details.email": {
"type": "string",
"description": "Email of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_details.first_name": {
"type": "string",
"description": "First name of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_details.last_name": {
"type": "string",
"description": "Last name of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"no-auth-billing-plan-transition": {
"name": "no-auth-billing-plan-transition",
      "displayName": "No Auth Billing Plan Transition",
      "operations": [
{
"name": "list_no_auth_billing_plan_transition",
      "description": "GetPlanTransition.",
"method": "GET",
"path": "/no_auth/namespaces/system/billing/plan_transition",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "state",
"type": "object",
"description": ""
}
]
}
]
},
	"no-auth-cname-lookup": {
"name": "no-auth-cname-lookup",
      "displayName": "No Auth Cname Lookup",
      "operations": [
{
"name": "list_no_auth_cname_lookup",
      "description": "Lookup cname.",
"method": "GET",
"path": "/no_auth/cname/lookup",
      "dangerLevel": "low",
"parameters": [
{
"name": "cname",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object"
}
}
]
},
	"no-auth-countries": {
"name": "no-auth-countries",
      "displayName": "No Auth Countries",
      "operations": [
{
"name": "get_no_auth_countrie",
      "description": "List countries.",
"method": "GET",
"path": "/no_auth/countries/{prefix}",
      "dangerLevel": "low",
"parameters": [
{
"name": "prefix",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"countries": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "countries",
"type": "array",
"description": "List of all countries supported by the platform."
}
]
}
]
},
	"no-auth-countries-states": {
"name": "no-auth-countries-states",
      "displayName": "No Auth Countries States",
      "operations": [
{
"name": "get_no_auth_countries_state",
      "description": "List states.",
"method": "GET",
"path": "/no_auth/countries/{country_code}/states/{prefix}",
      "dangerLevel": "low",
"parameters": [
{
"name": "country_code",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "prefix",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"states": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "error_code",
"type": "object",
"description": ""
},
{
"field": "states",
"type": "array",
"description": "List of all states of a country supported by the platform."
}
]
}
]
},
	"no-auth-countries-states-cities": {
"name": "no-auth-countries-states-cities",
      "displayName": "No Auth Countries States Cities",
      "operations": [
{
"name": "get_no_auth_countries_states_citie",
      "description": "List cities.",
"method": "GET",
"path": "/no_auth/countries/{country_code}/states/{state_code}/cities/{prefix}",
      "dangerLevel": "low",
"parameters": [
{
"name": "country_code",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "state_code",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "prefix",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"cities": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "cities",
"type": "array",
"description": "List of all cities in."
},
{
"field": "error_code",
"type": "object",
"description": ""
}
]
}
]
},
	"no-auth-f5xc-saas-signup": {
"name": "no-auth-f5xc-saas-signup",
      "displayName": "No Auth F5Xc Saas Signup",
      "operations": [
{
"name": "create_no_auth_f5xc_saas_signup",
      "description": "Signup XC SaaS.",
"method": "POST",
"path": "/no_auth/namespaces/system/f5xc-saas/signup",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "XCSaaSSignupRequest",
"x-displayname": "XC SaaS Signup Request.",
"x-ves-proto-message": "ves.io.schema.marketplace.xc_saas.XCSaaSSignupRequest",
"properties": {
"domain": {
"type": "string",
"description": "The domain associated with the tenant/account.",
"title": "domain",
"minLength": 1,
"maxLength": 17,
"x-displayname": "Domain",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "17",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "17",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"F5 Distributed Cloud\\\",\\\"f5\\\"]",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-example": "example.com",
"x-f5xc-description-short": "The domain associated with the tenant/account.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 17,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"format": "hostname",
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"token": {
      "type": "string",
"description": "The token contains the encrypted data, secured using an HMAC key.",
      "title": "token",
      "x-displayname": "Token",
      "x-f5xc-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7",
"x-f5xc-description-short": "The token contains the encrypted data, secured using an HMAC key.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for xc_saasXCSaaSSignupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for xc_saasXCSaaSSignupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for xc_saasXCSaaSSignupRequest"
},
"fieldMetadata": {
"domain": {
"type": "string",
"description": "The domain associated with the tenant/account.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 17,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"token": {
      "type": "string",
"description": "The token contains the encrypted data, secured using an HMAC key.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"no-auth-f5xc-saas-signup-registration-details": {
"name": "no-auth-f5xc-saas-signup-registration-details",
      "displayName": "No Auth F5Xc Saas Signup Registration Details",
      "operations": [
{
"name": "list_no_auth_f5xc_saas_signup_registration_details",
      "description": "GET Registration Details.",
"method": "GET",
"path": "/no_auth/namespaces/system/f5xc-saas/signup/registration_details",
      "dangerLevel": "low",
"parameters": [
{
"name": "token",
      "in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"console_url": {
"type": "string"
},
"domain": {
"type": "string"
},
"email": {
"type": "string"
},
"error_message": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "console_url",
"type": "string",
"description": "A URL to the console page, returned if the tenant is already signed up and active."
},
{
"field": "domain",
"type": "string",
"description": "The domain associated with the registered ASB message."
},
{
"field": "email",
"type": "string",
"description": "The email associated with the registered ASB message."
},
{
"field": "error_message",
"type": "string",
"description": "An error message providing additional details (e.g., tenant already signed up)"
}
]
}
]
},
	"no-auth-f5xc-saas-signup-send-email": {
"name": "no-auth-f5xc-saas-signup-send-email",
      "displayName": "No Auth F5Xc Saas Signup Send Email",
      "operations": [
{
"name": "create_no_auth_f5xc_saas_signup_send_email",
      "description": "Send Signup Email.",
"method": "POST",
"path": "/no_auth/namespaces/system/f5xc-saas/signup/send_email",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "The request message for SendSignupEmail.",
"title": "SendSignupEmailRequest",
"x-displayname": "Send Signup Email Request.",
"x-ves-proto-message": "ves.io.schema.marketplace.xc_saas.SendSignupEmailRequest",
"properties": {
"token": {
      "type": "string",
"description": "The token contains the encrypted data, secured using an HMAC key.",
      "title": "token",
      "x-displayname": "Token",
      "x-ves-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7.",
"x-f5xc-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7",
"x-f5xc-description-short": "The token contains the encrypted data, secured using an HMAC key.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "The request message for SendSignupEmail.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for xc_saasSendSignupEmailRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for xc_saasSendSignupEmailRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for xc_saasSendSignupEmailRequest"
},
"fieldMetadata": {
"token": {
      "type": "string",
"description": "The token contains the encrypted data, secured using an HMAC key.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "message",
"type": "string",
"description": "Message provides additional context regarding the result of the email send operation."
},
{
"field": "success",
"type": "boolean",
"description": "Indicates if the email was sent successfully."
}
]
}
]
},
	"no-auth-login-validate-registration": {
"name": "no-auth-login-validate-registration",
      "displayName": "No Auth Login Validate Registration",
      "operations": [
{
"name": "create_no_auth_login_validate_registration",
      "description": "Validate Registration.",
"method": "POST",
"path": "/no_auth/login/validate_registration",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "ValidateRegistrationRequest is the request body parameeters required to validate the registration.",
"title": "Request to validate registration",
"x-displayname": "Request to Validate Registration.",
"x-ves-proto-message": "ves.io.schema.signup.ValidateRegistrationRequest",
"properties": {
"email": {
"type": "string",
"description": "Email of the user requesting for.",
"title": "email of the user",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "dana@example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tenant_type": {
"allOf": [
{
"$ref": "#/components/schemas/schemaTenantType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"token": {
      "type": "string",
"description": "Token of the user requesting for.",
      "title": "token of the user",
      "x-displayname": "Token",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "ValidateRegistrationRequest is the request body parameeters required to validate the registration.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for signupValidateRegistrationRequest",
"required_fields": [
"email",
"token"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for signupValidateRegistrationRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  email: value\n  token: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"email\": \"value\",\n    \"token\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {
"valid_registration": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"email": "value",
"token": "value"
      }
},
"requiredFields": [
"email",
"token"
      ],
"description": "Minimum configuration for signupValidateRegistrationRequest"
},
"fieldMetadata": {
"email": {
"type": "string",
"description": "Email of the user requesting for.",
"constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tenant_type": {
"type": "string",
"description": "TenantType is the type of the customer\n\nUNKNOWN indicates the field not being set\nFREEMIUM are customer that don't have their domain\nENTERPRiISE customer have their domain.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNKNOWN"
},
"token": {
      "type": "string",
"description": "Token of the user requesting for.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
},
{
"field": "valid_registration",
"type": "boolean",
"description": "Valid registration flag indicates if the registration is valid."
}
]
}
]
},
	"no-auth-send-password-email": {
"name": "no-auth-send-password-email",
      "displayName": "No Auth Send Password Email",
      "operations": [
{
"name": "create_no_auth_send_password_email",
      "description": "Send Password Email.",
      "method": "POST",
"path": "/no_auth/send_password_email",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.",
      "title": "Request to resend password email",
      "x-displayname": "Signup Resend Password Email Request.",
      "x-ves-proto-message": "ves.io.schema.signup.SendPasswordEmailRequest",
      "properties": {
"cname": {
"type": "string",
"description": "Domain under which the tenant belongs to.",
"title": "cname",
"x-displayname": "Domain Name.",
"x-ves-example": "F5 Distributed Cloud.",
"x-f5xc-example": "F5 Distributed Cloud",
"x-f5xc-description-short": "Domain under which the tenant belongs to.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"email": {
"type": "string",
"description": "Email of the user requesting for.",
"title": "email of the user",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "dana@example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.",
      "x-f5xc-description-medium": "SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for signupSendPasswordEmailRequest",
      "required_fields": [
"email"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for signupSendPasswordEmailRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  email: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"email\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"email": "value"
}
},
"requiredFields": [
"email"
],
"description": "Minimum configuration for signupSendPasswordEmailRequest"
      },
"fieldMetadata": {
"cname": {
"type": "string",
"description": "Domain under which the tenant belongs to.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"email": {
"type": "string",
"description": "Email of the user requesting for.",
"constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"no-auth-signup": {
"name": "no-auth-signup",
      "displayName": "No Auth Signup",
      "operations": [
{
"name": "get_no_auth_signup",
      "description": "Read Signup.",
"method": "GET",
"path": "/no_auth/signup/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "object",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "Signup object status, including any failures."
}
]
}
]
},
	"no-auth-tenant-idm-settings-password-policy": {
"name": "no-auth-tenant-idm-settings-password-policy",
      "displayName": "No Auth Tenant Idm Settings Password Policy",
      "operations": [
{
"name": "list_no_auth_tenant_idm_settings_password_policy",
      "description": "GetPasswordPolicy.",
      "method": "GET",
"path": "/no_auth/tenant/idm/settings/password_policy",
      "dangerLevel": "low",
"parameters": [
{
"name": "realm_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"digits": {
"type": "integer"
},
"lowercase_characters": {
"type": "integer"
},
"minimum_length": {
"type": "integer"
},
"not_recently_used": {
"type": "integer"
},
"not_username": {
"type": "boolean"
},
"special_characters": {
"type": "integer"
},
"uppercase_characters": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "digits",
"type": "integer",
"description": "Number of digits."
},
{
"field": "lowercase_characters",
"type": "integer",
"description": "Number of lowercase characters."
},
{
"field": "minimum_length",
"type": "integer",
"description": "Minimum password length."
      },
{
"field": "not_recently_used",
"type": "integer",
"description": "Number of previous passwords to check for equality - if match found the password is rejected."
      },
{
"field": "not_username",
"type": "boolean",
"description": "If true then username must not appear in the password string."
      },
{
"field": "special_characters",
"type": "integer",
"description": "Number of special characters."
},
{
"field": "uppercase_characters",
"type": "integer",
"description": "Number of uppercase characters."
}
]
}
]
},
	"no-auth-validate-contact": {
"name": "no-auth-validate-contact",
      "displayName": "No Auth Validate Contact",
      "operations": [
{
"name": "create_no_auth_validate_contact",
      "description": "Validate contact.",
"method": "POST",
"path": "/no_auth/validate_contact",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Validate contacts request.",
"title": "Request to validate contact",
"x-displayname": "Validate contact request.",
"x-ves-proto-message": "ves.io.schema.signup.ValidateContactRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the configuration object to be fetched. Is not used for now.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the configuration object to be fetched. Is not used for now.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the configuration object is present. Is not used for now.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The namespace in which the configuration object is present. Is not used for now.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemacontactGlobalSpecType"
}
],
"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 signupValidateContactRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for signupValidateContactRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"is_valid": {
"type": "boolean"
},
"validation_errors": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for signupValidateContactRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the configuration object to be fetched. Is not used for now.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the configuration object is present. Is not used for now.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"spec.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
},
{
"field": "is_valid",
"type": "boolean",
"description": "Flag indicates if the contact is valid."
},
{
"field": "validation_errors",
"type": "array",
"description": "X-displayName : \"Validation errors\"\ncollection of validation errors."
}
]
}
]
},
	"oas-validation-suggestion": {
"name": "oas-validation-suggestion",
"displayName": "Oas Validation Suggestion",
"operations": [
{
"name": "create_oas_validation_suggestion",
"description": "Suggest Open API specification validation rule.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/oas_validation/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested Open API specification validation for a given path.",
      "title": "GetSuggestedOasValidationRuleReq",
"x-displayname": "GET Suggested Open API specification validation Rule Request.",
      "x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedOasValidationRuleReq",
"properties": {
"api_groups": {
      "type": "array",
"description": "List of API Groups the API Endpoint is a member of.",
      "title": "API Groups membership",
      "items": {
"type": "string"
},
"x-displayname": "API Groups membership.",
      "x-f5xc-example": "[\"group-1\", \"group-2\"]",
"x-f5xc-description-short": "List of API Groups the API Endpoint is a member of.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this Open API specification validation rule applied.",
      "title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this Open API specification validation rule applied.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the Open API specification validation to.",
      "title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-description-short": "Path to apply the Open API specification validation to.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested Open API specification validation for a given path.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedOasValidationRuleReq",
"required_fields": [
"path"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedOasValidationRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  path: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"path\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"path": "value"
}
},
"requiredFields": [
"path"
],
"description": "Minimum configuration for app_securityGetSuggestedOasValidationRuleReq"
},
"fieldMetadata": {
"api_groups": {
      "type": "array",
"description": "List of API Groups the API Endpoint is a member of.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this Open API specification validation rule applied.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the Open API specification validation to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "all_endpoints_oas_validation",
"type": "object",
"description": ""
},
{
"field": "custom_oas_validation",
"type": "object",
"description": ""
},
{
"field": "found_existing_rule",
"type": "object",
"description": ""
}
]
}
]
},
	"object-store": {
"name": "object-store",
"displayName": "Object Store",
"operations": [
{
"name": "get_object_store",
"description": "GET List Of Stored Objects.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "query_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "latest_version_only",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Stored object names and available versions for each object."
}
]
},
{
"name": "delete_object_store",
"description": "DELETE Stored Object(s)",
"method": "DELETE",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "force_delete",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_objects",
"type": "array",
"description": "Names of Deleted Object."
}
]
},
{
"name": "replace_object_store",
"description": "Create Stored Object.",
"method": "PUT",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request message for CreateObject API.",
      "title": "CreateObjectRequest",
"x-displayname": "Create Object Request.",
"x-ves-oneof-field-contents": "[\"bytes_value\",\"string_value\"]",
"x-ves-oneof-field-object_attributes": "[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"mobile_sdk_self_serve\",\"no_attributes\"]",
"x-ves-proto-message": "ves.io.schema.stored_object.CreateObjectRequest",
"properties": {
"bytes_value": {
"type": "string",
"description": "Exclusive with [string_value]\nBinary object contents. Should be encoded in base64 scheme.",
"title": "bytes_value",
"format": "byte",
"maximum": 5242880,
"x-displayname": "Byte Value.",
"x-ves-validation-rules": {
"ves.io.schema.rules.bytes.max_len": "5242880"
},
"x-validation-rules": {
"ves.io.schema.rules.bytes.max_len": "5242880"
},
"x-f5xc-description-short": "Exclusive with [string_value] Binary object contents. Should be encoded in base64 scheme.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"content_format": {
"type": "string",
"description": "The optional content format associated with object.",
"title": "content_format",
"x-displayname": "Content Format.",
"x-ves-example": "JSON, YAML.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.in": "[\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]"
},
"x-f5xc-example": "json, yaml",
"x-validation-rules": {
"ves.io.schema.rules.string.in": "[\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]"
},
"x-f5xc-description-short": "The optional content format associated with object.",
"enum": [
"",
"json",
"yaml",
"txt",
"bin"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "The optional description associated with object.",
"title": "description",
"maxLength": 512,
"x-displayname": "Description.",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "512"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "512"
},
"x-f5xc-description-short": "The optional description associated with object.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"mobile_app_shield": {
"allOf": [
{
"$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_integrator": {
"allOf": [
{
"$ref": "#/components/schemas/stored_objectMobileIntegratorAttributes"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_sdk": {
"allOf": [
{
"$ref": "#/components/schemas/stored_objectMobileSDKAttributes"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_sdk_self_serve": {
"allOf": [
{
"$ref": "#/components/schemas/stored_objectMobileSDKAttributes"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the stored_object.",
"title": "name",
"minLength": 1,
"maxLength": 512,
"x-displayname": "Name",
"x-ves-example": "Volt-API-specs.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "512",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-example": "volt-api-specs",
      "x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "512",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which object is to be created.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which object is to be created.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"no_attributes": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for no attributes.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"object_type": {
"type": "string",
"description": "Type of the stored_object.",
"title": "object_type",
"x-displayname": "Object Type.",
"x-ves-example": "Swagger",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\", \\\"mobile-sdk-self-serve\\\"]"
},
"x-f5xc-example": "swagger",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\", \\\"mobile-sdk-self-serve\\\"]"
},
"enum": [
"swagger",
"generic",
"big-object",
"mobile-sdk",
"mobile-integrator",
"mobile-app-shield",
"mobile-sdk-self-serve"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"string_value": {
"type": "string",
"description": "Exclusive with [bytes_value]\nString formatted contents.",
"title": "contents",
"maxLength": 5242880,
"x-displayname": "String Value.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "5242880"
},
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "5242880"
},
"x-f5xc-description-short": "Exclusive with [bytes_value] String formatted contents.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 5242880,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for stored_objectCreateObjectRequest",
"required_fields": [
"name",
"namespace",
"object_type"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for stored_objectCreateObjectRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  object_type: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"object_type\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "object_storage"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"object_type": "value"
}
},
"requiredFields": [
"name",
"namespace",
"object_type"
],
"description": "Minimum configuration for stored_objectCreateObjectRequest"
},
"fieldMetadata": {
"bytes_value": {
"type": "string",
"description": "Exclusive with [string_value]\nBinary object contents. Should be encoded in base64 scheme.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"content_format": {
"type": "string",
"description": "The optional content format associated with object.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"description": {
"type": "string",
"description": "The optional description associated with object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_app_shield": {
"type": "object",
"description": "Describes attributes specific to object type - mobile-app-shield.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_app_shield.os_type": {
"type": "string",
"description": "Defines a selection for operating system type. Its either ANDROID or IOS\n\n- ANDROID: ANDROID\n\n- IOS: IOS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANDROID"
},
"mobile_app_shield.release_version": {
"type": "string",
"description": "Version of mobile app shield release.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_integrator": {
"type": "object",
"description": "Describes attributes specific to object type - mobile-integrator.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_integrator.os_type": {
"type": "string",
"description": "Defines a selection for operating system type. Its either ANDROID or IOS\n\n- ANDROID: ANDROID\n\n- IOS: IOS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANDROID"
},
"mobile_integrator.release_version": {
"type": "string",
"description": "Version of mobile integrator release.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_sdk": {
"type": "object",
"description": "Describes attributes specific to object type - mobile-SDK.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_sdk.os_type": {
"type": "string",
"description": "Defines a selection for operating system type. Its either ANDROID or IOS\n\n- ANDROID: ANDROID\n\n- IOS: IOS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANDROID"
},
"mobile_sdk.release_version": {
"type": "string",
"description": "Version of mobile SDK release.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_sdk_self_serve": {
"type": "object",
"description": "Describes attributes specific to object type - mobile-SDK.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"mobile_sdk_self_serve.os_type": {
"type": "string",
"description": "Defines a selection for operating system type. Its either ANDROID or IOS\n\n- ANDROID: ANDROID\n\n- IOS: IOS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANDROID"
},
"mobile_sdk_self_serve.release_version": {
"type": "string",
"description": "Version of mobile SDK release.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the stored_object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which object is to be created.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"no_attributes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"object_type": {
"type": "string",
"description": "Type of the stored_object.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"string_value": {
"type": "string",
"description": "Exclusive with [bytes_value]\nString formatted contents.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 5242880,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"contents": [
"bytes_value",
"string_value"
],
"object_attributes": [
"mobile_app_shield",
"mobile_integrator",
"mobile_sdk",
"mobile_sdk_self_serve",
"no_attributes"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "no_additional_info",
"type": "object",
"description": ""
},
{
"field": "presigned_url",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "object",
"description": ""
}
]
}
]
},
	"object-store-mobile-app-shield": {
"name": "object-store-mobile-app-shield",
"displayName": "Object Store Mobile App Shield",
"operations": [
{
"name": "list_object_store_mobile_app_shield",
"description": "GET List Of Mobile App Shields.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "query_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "latest_version_only",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Stored object names and available versions for each object."
}
]
},
{
"name": "get_object_store_mobile_app_shield",
"description": "GET Mobile App Shield.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield/{name}/{version}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"bytes_value": {
"type": "string"
},
"content_format": {
"type": "string"
},
"string_value": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "bytes_value",
"type": "string",
"description": "Exclusive with [presigned_url string_value]\nBinary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object."
},
{
"field": "content_format",
"type": "string",
"description": "The optional content format associated with object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "presigned_url",
"type": "object",
"description": ""
},
{
"field": "string_value",
"type": "string",
"description": "Exclusive with [bytes_value presigned_url]\nString formatted contents."
}
]
}
]
},
	"object-store-mobile-integrator": {
"name": "object-store-mobile-integrator",
"displayName": "Object Store Mobile Integrator",
"operations": [
{
"name": "list_object_store_mobile_integrator",
"description": "GET List Of Mobile Integrators.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "query_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "latest_version_only",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Stored object names and available versions for each object."
}
]
},
{
"name": "get_object_store_mobile_integrator",
"description": "GET Mobile Integrator.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator/{name}/{version}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"bytes_value": {
"type": "string"
},
"content_format": {
"type": "string"
},
"string_value": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "bytes_value",
"type": "string",
"description": "Exclusive with [presigned_url string_value]\nBinary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object."
},
{
"field": "content_format",
"type": "string",
"description": "The optional content format associated with object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "presigned_url",
"type": "object",
"description": ""
},
{
"field": "string_value",
"type": "string",
"description": "Exclusive with [bytes_value presigned_url]\nString formatted contents."
}
]
}
]
},
	"object-store-mobile-sdk": {
"name": "object-store-mobile-sdk",
"displayName": "Object Store Mobile Sdk",
"operations": [
{
"name": "list_object_store_mobile_sdk",
"description": "GET List Of Mobile SDKs.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "query_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "latest_version_only",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Stored object names and available versions for each object."
}
]
},
{
"name": "get_object_store_mobile_sdk",
"description": "GET Mobile SDK.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk/{name}/{version}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"bytes_value": {
"type": "string"
},
"content_format": {
"type": "string"
},
"string_value": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "bytes_value",
"type": "string",
"description": "Exclusive with [presigned_url string_value]\nBinary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object."
},
{
"field": "content_format",
"type": "string",
"description": "The optional content format associated with object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "presigned_url",
"type": "object",
"description": ""
},
{
"field": "string_value",
"type": "string",
"description": "Exclusive with [bytes_value presigned_url]\nString formatted contents."
}
]
}
]
},
	"object-store-mobile-sdk-self-serve": {
"name": "object-store-mobile-sdk-self-serve",
"displayName": "Object Store Mobile Sdk Self Serve",
"operations": [
{
"name": "list_object_store_mobile_sdk_self_serve",
"description": "GET List Of Mobile SDKs self serve.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk-self-serve",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "query_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "latest_version_only",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Stored object names and available versions for each object."
}
]
},
{
"name": "get_object_store_mobile_sdk_self_serve",
"description": "GET Mobile SDK Self serve.",
"method": "GET",
"path": "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk-self-serve/{name}/{version}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "object_type",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"bytes_value": {
"type": "string"
},
"content_format": {
"type": "string"
},
"string_value": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "bytes_value",
"type": "string",
"description": "Exclusive with [presigned_url string_value]\nBinary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object."
},
{
"field": "content_format",
"type": "string",
"description": "The optional content format associated with object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "presigned_url",
"type": "object",
"description": ""
},
{
"field": "string_value",
"type": "string",
"description": "Exclusive with [bytes_value presigned_url]\nString formatted contents."
}
]
}
]
},
	"observability-connector-observability-subscribe": {
"name": "observability-connector-observability-subscribe",
"displayName": "Observability Connector Observability Subscribe",
"operations": [
{
"name": "create_observability_connector_observability_subscribe",
"description": "Subscribe to Observability service.",
"method": "POST",
"path": "/api/observability/connector/namespaces/system/observability/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Observability Synthetic Monitor.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-oneof-field-service": "[\"syntheticMonitors\"]",
"x-ves-proto-message": "ves.io.schema.observability.subscription.SubscribeRequest",
"properties": {
"syntheticMonitors": {
"allOf": [
{
"$ref": "#/components/schemas/subscriptionSyntheticMonitors"
}
],
"x-f5xc-description-short": "Configuration parameter for syntheticMonitors.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to subscribe to Observability Synthetic Monitor.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
},
"fieldMetadata": {
"syntheticMonitors": {
"type": "object",
"description": "Option to subscribe to synthetic monitors.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"service": [
"syntheticMonitors"
]
}
}
]
},
	"observability-connector-observability-unsubscribe": {
"name": "observability-connector-observability-unsubscribe",
"displayName": "Observability Connector Observability Unsubscribe",
"operations": [
{
"name": "create_observability_connector_observability_unsubscribe",
"description": "Unsubscribe to Observability Synthetic Monitor.",
"method": "POST",
"path": "/api/observability/connector/namespaces/system/observability/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Observability Synthetic Monitor.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-oneof-field-service": "[\"syntheticMonitors\"]",
"x-ves-proto-message": "ves.io.schema.observability.subscription.UnsubscribeRequest",
"properties": {
"syntheticMonitors": {
"allOf": [
{
"$ref": "#/components/schemas/subscriptionSyntheticMonitors"
}
],
"x-f5xc-description-short": "Configuration parameter for syntheticMonitors.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to unsubscribe to Observability Synthetic Monitor.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
},
"fieldMetadata": {
"syntheticMonitors": {
"type": "object",
"description": "Option to subscribe to synthetic monitors.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"service": [
"syntheticMonitors"
]
}
}
]
},
	"observability-synthetic-monitor": {
"name": "observability-synthetic-monitor",
"displayName": "Observability Synthetic Monitor",
"operations": [
{
"name": "create_observability_synthetic_monitor",
"description": "Create DNS Monitor.",
"method": "POST",
"path": "/api/observability/synthetic_monitor/namespaces/{namespace}/v1_dns_monitors",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of v1_dns_monitor",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.observability.synthetic_monitor.v1_dns_monitor.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/v1_dns_monitorCreateSpecType"
}
],
"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 v1_dns_monitorCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for v1_dns_monitorCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for v1_dns_monitorCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a new DNS Monitor.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain": {
"type": "string",
"description": "Domain name for routing and identification",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.external_sources": {
"type": "array",
"description": "Internet facing monitor sources.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.health_policy": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.dynamic_threshold": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.dynamic_threshold_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_max_threshold": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_max_threshold_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_min_threshold": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_min_threshold_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_12_hours": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_15_mins": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_1_day": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_1_hour": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_1_min": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_30_mins": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_30_secs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_5_mins": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_6_hours": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lookup_timeout": {
"type": "integer",
"description": "The amount of time in milliseconds before the monitor considers a pending request to be a failure.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.name_servers": {
"type": "array",
"description": "Human-readable name for the resource",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.on_failure_count": {
"type": "integer",
"description": "The number of times a monitor must fail before the global monitor changes health.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.on_failure_to_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.on_failure_to_any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Configuration parameter for protocol",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.receive": {
"type": "string",
"description": "The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.record_type": {
"type": "string",
"description": "Type or category classification",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.source_critical_threshold": {
"type": "integer",
"description": "The number of provider-regions a monitor must fail from before the global monitor changes health.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 256,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.interval_choice": [
"interval_12_hours",
"interval_15_mins",
"interval_1_day",
"interval_1_hour",
"interval_1_min",
"interval_30_mins",
"interval_30_secs",
"interval_5_mins",
"interval_6_hours"
],
"spec.on_failure_to_choice": [
"on_failure_to_all",
"on_failure_to_any"
],
"spec.health_policy.dynamic_threshold_policy": [
"dynamic_threshold",
"dynamic_threshold_disabled"
],
"spec.health_policy.static_max_threshold_policy": [
"static_max_threshold",
"static_max_threshold_disabled"
],
"spec.health_policy.static_min_threshold_policy": [
"static_min_threshold",
"static_min_threshold_disabled"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_observability_synthetic_monitor",
"description": "Replace DNS Monitor.",
"method": "PUT",
"path": "/api/observability/synthetic_monitor/namespaces/{namespace}/v1_dns_monitors/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a v1_dns_monitor",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.observability.synthetic_monitor.v1_dns_monitor.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/v1_dns_monitorReplaceSpecType"
}
],
"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 v1_dns_monitorReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for v1_dns_monitorReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for v1_dns_monitorReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace the contents of a DNS Monitor.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain": {
"type": "string",
"description": "Domain name for routing and identification",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.external_sources": {
"type": "array",
"description": "Internet facing monitor sources.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.health_policy": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.dynamic_threshold": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.dynamic_threshold_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_max_threshold": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_max_threshold_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_min_threshold": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.health_policy.static_min_threshold_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_12_hours": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_15_mins": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_1_day": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_1_hour": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_1_min": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_30_mins": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_30_secs": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_5_mins": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.interval_6_hours": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lookup_timeout": {
"type": "integer",
"description": "The amount of time in milliseconds before the monitor considers a pending request to be a failure.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 10,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.name_servers": {
"type": "array",
"description": "Human-readable name for the resource",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.on_failure_count": {
"type": "integer",
"description": "The number of times a monitor must fail before the global monitor changes health.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.on_failure_to_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.on_failure_to_any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.protocol": {
"type": "string",
"description": "Configuration parameter for protocol",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.receive": {
"type": "string",
"description": "The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.record_type": {
"type": "string",
"description": "Type or category classification",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.source_critical_threshold": {
"type": "integer",
"description": "The number of provider-regions a monitor must fail from before the global monitor changes health.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 256,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.interval_choice": [
"interval_12_hours",
"interval_15_mins",
"interval_1_day",
"interval_1_hour",
"interval_1_min",
"interval_30_mins",
"interval_30_secs",
"interval_5_mins",
"interval_6_hours"
],
"spec.on_failure_to_choice": [
"on_failure_to_all",
"on_failure_to_any"
],
"spec.health_policy.dynamic_threshold_policy": [
"dynamic_threshold",
"dynamic_threshold_disabled"
],
"spec.health_policy.static_max_threshold_policy": [
"static_max_threshold",
"static_max_threshold_disabled"
],
"spec.health_policy.static_min_threshold_policy": [
"static_min_threshold",
"static_min_threshold_disabled"
]
}
},
{
"name": "list_observability_synthetic_monitor",
"description": "GET Certificate Report Detail.",
"method": "GET",
"path": "/api/observability/synthetic_monitor/namespaces/{namespace}/certificate-report-detail",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"entries": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "entries",
"type": "array",
"description": "Entries in certificate report detail response."
}
]
},
{
"name": "delete_observability_synthetic_monitor",
"description": "DELETE DNS Monitor.",
"method": "DELETE",
"path": "/api/observability/synthetic_monitor/namespaces/{namespace}/v1_dns_monitors/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a v1_dns_monitor",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.observability.synthetic_monitor.v1_dns_monitor.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for v1_dns_monitorDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for v1_dns_monitorDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_observability_synthetic_monitor",
"description": "GET DNS Monitor.",
"method": "GET",
"path": "/api/observability/synthetic_monitor/namespaces/{namespace}/v1_dns_monitors/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"operate-sites-vpm-debug-change-password": {
"name": "operate-sites-vpm-debug-change-password",
      "displayName": "Operate Sites Vpm Debug Change Password",
      "operations": [
{
"name": "create_operate_sites_vpm_debug_change_password",
      "description": "ChangePassword.",
      "method": "POST",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/{node}/change-password",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Change password request for host.",
      "title": "Change Password Request",
      "x-displayname": "Change Password Request.",
      "x-ves-proto-message": "ves.io.schema.operate.debug.ChangePasswordRequest",
      "properties": {
"console_user": {
"type": "string",
"description": "Name of the console user who runs this command.",
"title": "User",
"x-displayname": "User",
"x-ves-example": "Console-user.",
"x-f5xc-example": "console-user",
"x-f5xc-description-short": "Name of the console user who runs this command.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password": {
      "allOf": [
{
"$ref": "#/components/schemas/schemaSecretType"
      }
],
"x-f5xc-description-short": "Configuration parameter for current password.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password": {
      "allOf": [
{
"$ref": "#/components/schemas/schemaSecretType"
      }
],
"x-f5xc-description-short": "Configuration parameter for new password.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"username": {
"type": "string",
"description": "The user to change password on host.",
      "title": "Username",
"x-displayname": "Username",
"x-ves-example": "Username",
"x-f5xc-example": "username",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugChangePasswordRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugChangePasswordRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for debugChangePasswordRequest"
      },
"fieldMetadata": {
"console_user": {
"type": "string",
"description": "Name of the console user who runs this command.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password.blindfold_secret_info.decryption_provider": {
      "type": "string",
"description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password.blindfold_secret_info.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.",
"constraints": {
"constraintType": "string",
"category": "content",
"minLength": 4,
"maxLength": 131072,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "manual-override",
"confidence": 1,
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"current_password.blindfold_secret_info.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:///.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password.clear_secret_info.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:///.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"current_password.clear_secret_info.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 131072
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"new_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password.blindfold_secret_info": {
      "type": "object",
"description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password.blindfold_secret_info.decryption_provider": {
      "type": "string",
"description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password.blindfold_secret_info.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.",
"constraints": {
"constraintType": "string",
"category": "content",
"minLength": 4,
"maxLength": 131072,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "manual-override",
"confidence": 1,
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"new_password.blindfold_secret_info.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:///.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password.clear_secret_info": {
      "type": "object",
"description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password.clear_secret_info.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:///.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_password.clear_secret_info.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 131072
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"username": {
"type": "string",
"description": "The user to change password on host.",
      "constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"current_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"new_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ]
}
}
]
},
	"operate-sites-vpm-debug-global-allow-f5-ssh": {
"name": "operate-sites-vpm-debug-global-allow-f5-ssh",
"displayName": "Operate Sites Vpm Debug Global Allow F5 Ssh",
"operations": [
{
"name": "create_operate_sites_vpm_debug_global_allow_f5_ssh",
"description": "Allow F5 SSH.",
"method": "POST",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/allow-f5-ssh",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to control F5 SSH access (vesop) on host. This API allows enabling or disabling vesop SSH access\nwith optional timer-based auto-disable functionality.",
      "title": "Allow F5 SSH Request",
"x-displayname": "Allow F5 SSH Request.",
"x-ves-proto-message": "ves.io.schema.operate.debug.AllowF5SSHRequest",
"properties": {
"enable": {
"type": "boolean",
"description": "Enables or disables F5 SSH (vesop) access on the site. When enabled, F5 support can SSH to the site for troubleshooting purposes.",
      "title": "Enable",
"format": "boolean",
"x-displayname": "Enable",
"x-ves-example": "True",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "true",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Enables or disables F5 SSH (vesop) access on the site. When enabled, F5 support can SSH to the site for troubleshooting purposes.",
      "x-f5xc-description-medium": "Enables or disables F5 SSH (vesop) access on the site. When enabled, F5 support can SSH to the site for troubleshooting purposes.",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"enabled_duration": {
"type": "integer",
"description": "Duration in minutes for which F5 SSH access is enabled. Set to 0 for permanent enable/disable without timer.\nWhen enable=true and enabled_duration > 0, vesop access will be automatically disabled after this duration.",
      "title": "Enabled Duration",
"format": "int64",
"x-displayname": "Enabled Duration.",
"x-ves-example": "5",
"x-f5xc-example": "5",
"x-f5xc-description-short": "Duration in minutes for which F5 SSH access is enabled. Set to 0 for permanent enable/disable without timer.",
      "x-f5xc-description-medium": "Duration in minutes for which F5 SSH access is enabled. Set to 0 for permanent enable/disable without timer. When enable=true and enabled_duration > 0, vesop access will be automatically disabled after this duration.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"single_node": {
"type": "boolean",
"description": "Field to indicate single node operation.",
"title": "Single Node",
"format": "boolean",
"x-displayname": "Single Node.",
"x-f5xc-description-short": "Field to indicate single node operation.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site where F5 SSH access will be controlled.",
      "title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "AWS-site",
"x-f5xc-example": "aws-site",
"x-f5xc-description-short": "Name of the site where F5 SSH access will be controlled.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to control F5 SSH access (vesop) on host.",
      "x-f5xc-description-medium": "Request to control F5 SSH access (vesop) on host. This API allows enabling or disabling vesop SSH access with optional timer-based auto-disable functionality.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugAllowF5SSHRequest",
"required_fields": [
"enable"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugAllowF5SSHRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  enable: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"enable\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"enable": "value"
}
},
"requiredFields": [
"enable"
],
"description": "Minimum configuration for debugAllowF5SSHRequest"
},
"fieldMetadata": {
"enable": {
"type": "boolean",
"description": "Enables or disables F5 SSH (vesop) access on the site. When enabled, F5 support can SSH to the site for troubleshooting purposes.",
      "required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"enabled_duration": {
"type": "integer",
"description": "Duration in minutes for which F5 SSH access is enabled. Set to 0 for permanent enable/disable without timer.\nWhen enable=true and enabled_duration > 0, vesop access will be automatically disabled after this duration.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"single_node": {
"type": "boolean",
"description": "Field to indicate single node operation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site where F5 SSH access will be controlled.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-sites-vpm-debug-global-check-debug-info-collection": {
"name": "operate-sites-vpm-debug-global-check-debug-info-collection",
"displayName": "Operate Sites Vpm Debug Global Check Debug Info Collection",
"operations": [
{
"name": "list_operate_sites_vpm_debug_global_check_debug_info_collection",
"description": "Check Debug Info Collection.",
"method": "GET",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/check-debug-info-collection",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"collection_start_time": {
"type": "string"
},
"debug_in_progress": {
"type": "boolean"
},
"node_name": {
"type": "string"
},
"validity": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "collection_start_time",
"type": "string",
"description": "The UTC timestamp when the collection start."
},
{
"field": "debug_in_progress",
"type": "boolean",
"description": "True if debug is in progress."
},
{
"field": "node_name",
"type": "string",
"description": "Name of the debug bundle."
},
{
"field": "validity",
"type": "string",
"description": "The UTC timestamp of the validity of debug bundle."
}
]
}
]
},
	"operate-sites-vpm-debug-global-diagnosis": {
"name": "operate-sites-vpm-debug-global-diagnosis",
"displayName": "Operate Sites Vpm Debug Global Diagnosis",
"operations": [
{
"name": "list_operate_sites_vpm_debug_global_diagnosis",
"description": "Diagnosis",
"method": "GET",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/diagnosis",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "console_user",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"curl_response": {
"type": "object"
},
"registration_status": {
"type": "object"
},
"responses": {
"type": "object"
}
}
},
"responseSummary": [
{
"field": "curl_response",
"type": "object",
"description": "The subset from full diagnosis response of Domain Curl Result for all required domains from all nodes."
},
{
"field": "registration_status",
"type": "object",
"description": "The subset from full diagnosis response of Registration Status from all nodes."
},
{
"field": "responses",
"type": "object",
"description": "The full diagnosis response of all nodes."
}
]
}
]
},
	"operate-sites-vpm-debug-global-download-debug-info-collection": {
"name": "operate-sites-vpm-debug-global-download-debug-info-collection",
"displayName": "Operate Sites Vpm Debug Global Download Debug Info Collection",
"operations": [
{
"name": "list_operate_sites_vpm_debug_global_download_debug_info_collection",
"description": "Download Debug Info Collection.",
"method": "GET",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/download-debug-info-collection",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"operate-sites-vpm-debug-global-health": {
"name": "operate-sites-vpm-debug-global-health",
"displayName": "Operate Sites Vpm Debug Global Health",
"operations": [
{
"name": "list_operate_sites_vpm_debug_global_health",
"description": "Health",
"method": "GET",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/health",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "console_user",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"fqdn": {
"type": "string"
},
"hostname": {
"type": "string"
},
"initial_password_changed": {
      "type": "boolean"
},
"lte_support": {
"type": "boolean"
},
"os_version": {
"type": "string"
},
"public_ip": {
"type": "string"
},
"roles": {
"type": "array"
},
"software_version": {
"type": "string"
},
"version": {
"type": "string"
},
"vesop_ssh_enabled": {
"type": "boolean"
},
"vesop_ssh_remaining_time": {
"type": "string"
},
"wifi_support": {
"type": "boolean"
}
}
},
"responseSummary": [
{
"field": "fqdn",
"type": "string",
"description": "Node FQDN used during registration."
},
{
"field": "hostname",
"type": "string",
"description": "Hostname of the node."
},
{
"field": "initial_password_changed",
      "type": "boolean",
"description": "If the factory password changed on host."
      },
{
"field": "lte_support",
"type": "boolean",
"description": "If the box has LTE support."
},
{
"field": "os_info",
"type": "object",
"description": ""
},
{
"field": "os_version",
"type": "string",
"description": "OS version on host."
},
{
"field": "public_ip",
"type": "string",
"description": "Public IP gives vhost0 or other primary IP."
},
{
"field": "roles",
"type": "array",
"description": "If node is worker node."
},
{
"field": "software_version",
"type": "string",
"description": "F5 Distributed Cloud software version."
},
{
"field": "state",
"type": "object",
"description": ""
},
{
"field": "version",
"type": "string",
"description": "VPM version running on host."
},
{
"field": "vesop_ssh_enabled",
"type": "boolean",
"description": "Indicates whether F5 (vesop) SSH access is currently enabled on the site."
      },
{
"field": "vesop_ssh_remaining_time",
"type": "string",
"description": "Displays the remaining time until F5 (vesop) SSH access is enabled. Empty if SSH is disabled or permanently enabled."
      },
{
"field": "wifi_support",
"type": "boolean",
"description": "If the box has WIFI support."
}
]
}
]
},
	"operate-sites-vpm-debug-start-debug-info-collection": {
"name": "operate-sites-vpm-debug-start-debug-info-collection",
"displayName": "Operate Sites Vpm Debug Start Debug Info Collection",
"operations": [
{
"name": "list_operate_sites_vpm_debug_start_debug_info_collection",
"description": "Start Debug Info Collection.",
"method": "GET",
"path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/{node}/start-debug-info-collection",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
]
}
]
},
	"operate-ver-bgp-peers": {
"name": "operate-ver-bgp-peers",
"displayName": "Operate Ver Bgp Peers",
"operations": [
{
"name": "list_operate_ver_bgp_peers",
"description": "Show BGP Peer Info.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"ver": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "ver",
"type": "array",
"description": "Peer Status information from each ver instance."
}
]
}
]
},
	"operate-ver-bgp-routes": {
"name": "operate-ver-bgp-routes",
"displayName": "Operate Ver Bgp Routes",
"operations": [
{
"name": "list_operate_ver_bgp_routes",
"description": "Show BGP Routes.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"ver": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "ver",
"type": "array",
"description": "Routes per instance per table from each ver instance."
}
]
}
]
},
	"operate-ver-dhcp-leases": {
"name": "operate-ver-dhcp-leases",
"displayName": "Operate Ver Dhcp Leases",
"operations": [
{
"name": "list_operate_ver_dhcp_leases",
"description": "Show DHCP Leases.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/dhcp_leases",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"lease_info": {
"type": "array"
},
"subnet_info": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "lease_info",
"type": "array",
"description": "DHCP lease information."
},
{
"field": "subnet_info",
"type": "array",
"description": "DHCP information per subnet."
}
]
}
]
},
	"operate-ver-fetchdump": {
"name": "operate-ver-fetchdump",
"displayName": "Operate Ver Fetchdump",
"operations": [
{
"name": "create_operate_ver_fetchdump",
"description": "FetchDump",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/fetchdump",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch captured pcap data from an earlier Tcpdump request.",
"title": "PCAP Fetch Request",
"x-displayname": "PCAP Fetch Request.",
"x-ves-displayorder": "1,2,3,5",
"x-ves-proto-message": "ves.io.schema.operate.tcpdump.FetchRequest",
"properties": {
"intf": {
"allOf": [
{
"$ref": "#/components/schemas/schemaInterfaceOrNetwork"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node on which Tcpdump was run.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node on which Tcpdump was run.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which Tcpdump was run.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site on which Tcpdump was run.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to fetch captured pcap data from an earlier Tcpdump request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tcpdumpFetchRequest",
"required_fields": [
"node"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tcpdumpFetchRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  node: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"node\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"node": "value"
}
},
"requiredFields": [
"node"
],
"description": "Minimum configuration for tcpdumpFetchRequest"
},
"fieldMetadata": {
"intf": {
"type": "object",
"description": "Selects an interface on a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.intf": {
"type": "string",
"description": "Exclusive with [pod vn vn_type]\nName of the chosen interface on the node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.pod": {
"type": "string",
"description": "Exclusive with [intf vn vn_type]\nName of the pod whose interface on the node is chosen.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.vn": {
"type": "string",
"description": "Exclusive with [intf pod vn_type]\nName of chosen Virtual Network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.vn_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node on which Tcpdump was run.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which Tcpdump was run.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"intf.interface_choice": [
"intf",
"pod",
"vn",
"vn_type"
]
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"operate-ver-list-tcpdump": {
"name": "operate-ver-list-tcpdump",
"displayName": "Operate Ver List Tcpdump",
"operations": [
{
"name": "create_operate_ver_list_tcpdump",
"description": "List Tcpdump.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/list_tcpdump",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to list Tcpdump capture status on a node.",
"title": "List Request",
"x-displayname": "List Request.",
"x-ves-displayorder": "1,2,3",
"x-ves-proto-message": "ves.io.schema.operate.tcpdump.ListRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node on which Tcpdump status is requested.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node on which Tcpdump status is requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which Tcpdump status is requested.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site on which Tcpdump status is requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to list Tcpdump capture status on a node.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tcpdumpListRequest",
"required_fields": [
"node"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tcpdumpListRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  node: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"node\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"intf_status": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"node": "value"
}
},
"requiredFields": [
"node"
],
"description": "Minimum configuration for tcpdumpListRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node on which Tcpdump status is requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which Tcpdump status is requested.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "intf_status",
"type": "array",
"description": "List of Interfaces along with their last run tcpdump status."
}
]
}
]
},
	"operate-ver-matching-flows": {
"name": "operate-ver-matching-flows",
"displayName": "Operate Ver Matching Flows",
"operations": [
{
"name": "create_operate_ver_matching_flow",
"description": "Show Matching Flows.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/matching_flows",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET list of VER flows matching the request.",
"title": "Flow Match Request",
"x-displayname": "Flow Match Request.",
"x-ves-oneof-field-interface_or_network": "[\"external_service\",\"intf\",\"pod\",\"vn\",\"vn_type\"]",
"x-ves-proto-message": "ves.io.schema.operate.flow.FlowMatchRequest",
"properties": {
"dest": {
"type": "string",
"description": "Destination Address of the flow (optional)",
"title": "Destination Address",
"x-displayname": "Destination Address.",
"x-ves-example": "192.0.2.104.",
"x-f5xc-example": "192.0.2.104",
"x-f5xc-description-short": "Destination Address of the flow (optional).",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest_port": {
"type": "integer",
"description": "Destination port of the flow (optional)",
"title": "Destination Port",
"format": "int64",
"x-displayname": "Destination Port.",
"x-ves-example": "22225",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "65535"
},
"x-f5xc-example": "22225",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "65535"
},
"x-f5xc-description-short": "Destination port of the flow (optional).",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"external_service": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-description-short": "Configuration parameter for external service.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf": {
"type": "string",
"description": "Exclusive with [external_service pod vn vn_type]\nName of the Interface on which flows are to be matched.",
"title": "Interface",
"x-displayname": "Interface",
"x-ves-example": "Eth0",
"x-f5xc-example": "eth0",
"x-f5xc-description-short": "Exclusive with [external_service pod vn vn_type] Name of the Interface on which flows are to be matched.",
"x-f5xc-description-medium": "Exclusive with [external_service pod vn vn_type] Name of the Interface on which flows are to be matched.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node from which flows are requested.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node from which flows are requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pod": {
"type": "string",
"description": "Exclusive with [external_service intf vn vn_type]\nName of the pod for which flows are to be matched.",
"title": "Pod Name",
"x-displayname": "Pod Name",
"x-ves-example": "Pod-5444dcd747-868hq.",
"x-f5xc-example": "pod-5444dcd747-868hq",
"x-f5xc-description-short": "Exclusive with [external_service intf vn vn_type] Name of the pod for which flows are to be matched.",
"x-f5xc-description-medium": "Exclusive with [external_service intf vn vn_type] Name of the pod for which flows are to be matched.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"proto": {
"type": "integer",
"description": "Protocol of the flow (optional)",
"title": "Protocol",
"format": "int64",
"x-displayname": "Protocol",
"x-ves-example": "6",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "255"
},
"x-f5xc-example": "6",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "255"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 255,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"seconds": {
"type": "integer",
"description": "Number of seconds for which flows are requested.\nA value of 100 returns flows created in the past 100 seconds,\nwith a maximum of 1024 flows. A value of 0 returns all matching\nflows upto a maximum of 1024.",
"title": "Seconds",
"format": "int64",
"x-displayname": "Seconds",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Number of seconds for which flows are requested. A value of 100 returns flows created in the past 100 seconds, with a maximum of 1024 flows.",
"x-f5xc-description-medium": "Number of seconds for which flows are requested. A value of 100 returns flows created in the past 100 seconds, with a maximum of 1024 flows. A value of 0 returns all matching flows upto a maximum of 1024.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site from which flows are requested.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site from which flows are requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src": {
"type": "string",
"description": "Source Address of the flow (optional)",
"title": "Source Address",
"x-displayname": "Source Address.",
"x-ves-example": "192.0.2.104.",
"x-f5xc-example": "192.0.2.104",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_port": {
"type": "integer",
"description": "Source port of the flow (optional)",
"title": "Source Port",
"format": "int64",
"x-displayname": "Source Port.",
"x-ves-example": "22225",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "65535"
},
"x-f5xc-example": "22225",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "65535"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn": {
"type": "string",
"description": "Exclusive with [external_service intf pod vn_type]\nName of Virtual Network on which flows are matched.",
"title": "Virtual Network",
"x-displayname": "Virtual Network.",
"x-ves-example": "Site-local-outside-vn.",
"x-f5xc-example": "site-local-outside-vn",
"x-f5xc-description-short": "Exclusive with [external_service intf pod vn_type] Name of Virtual Network on which flows are matched.",
"x-f5xc-description-medium": "Exclusive with [external_service intf pod vn_type] Name of Virtual Network on which flows are matched.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn_type": {
"allOf": [
{
"$ref": "#/components/schemas/schemaVirtualNetworkType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET list of VER flows matching the request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for flowFlowMatchRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for flowFlowMatchRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"flow": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for flowFlowMatchRequest"
},
"fieldMetadata": {
"dest": {
"type": "string",
"description": "Destination Address of the flow (optional)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest_port": {
"type": "integer",
"description": "Destination port of the flow (optional)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"external_service": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf": {
"type": "string",
"description": "Exclusive with [external_service pod vn vn_type]\nName of the Interface on which flows are to be matched.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node from which flows are requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pod": {
"type": "string",
"description": "Exclusive with [external_service intf vn vn_type]\nName of the pod for which flows are to be matched.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"proto": {
"type": "integer",
"description": "Protocol of the flow (optional)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 255,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"seconds": {
"type": "integer",
"description": "Number of seconds for which flows are requested.\nA value of 100 returns flows created in the past 100 seconds,\nwith a maximum of 1024 flows. A value of 0 returns all matching\nflows upto a maximum of 1024.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site from which flows are requested.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src": {
"type": "string",
"description": "Source Address of the flow (optional)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_port": {
"type": "integer",
"description": "Source port of the flow (optional)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn": {
"type": "string",
"description": "Exclusive with [external_service intf pod vn_type]\nName of Virtual Network on which flows are matched.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
}
},
"oneOfVariants": {
"interface_or_network": [
"external_service",
"intf",
"pod",
"vn",
"vn_type"
]
},
"responseSummary": [
{
"field": "flow",
"type": "array",
"description": "Flow information."
}
]
}
]
},
	"operate-ver-ping": {
"name": "operate-ver-ping",
"displayName": "Operate Ver Ping",
"operations": [
{
"name": "create_operate_ver_ping",
"description": "Ping",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/ping",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to run ping to a destination.",
"title": "Ping Request",
"x-displayname": "Ping Request.",
"x-ves-proto-message": "ves.io.schema.operate.ping.PingRequest",
"properties": {
"count": {
"type": "integer",
"description": "Number of ping requests to be sent.",
"title": "Count",
"format": "int64",
"x-displayname": "Count",
"x-ves-example": "3",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "64"
},
"x-f5xc-example": "3",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "64"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 64,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHostIdentifier"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"interval": {
"type": "integer",
"description": "Interval between ping requests, in milliseconds.",
"title": "Interval",
"format": "int64",
"x-displayname": "Interval",
"x-ves-example": "1000",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "300",
"ves.io.schema.rules.uint32.lte": "10000"
},
"x-f5xc-example": "1000",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "300",
"ves.io.schema.rules.uint32.lte": "10000"
},
"x-f5xc-description-short": "Interval between ping requests, in milliseconds.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 300,
"maximum": 10000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"intf": {
"allOf": [
{
"$ref": "#/components/schemas/schemaInterfaceIdentifier"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node from which ping is initiated.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node from which ping is initiated.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pkt_size": {
"type": "integer",
"description": "Ping packet size.",
"title": "Packet Size",
"format": "int64",
"x-displayname": "Packet Size.",
"x-ves-example": "64",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "64",
"ves.io.schema.rules.uint32.lte": "9216"
},
"x-f5xc-example": "64",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "64",
"ves.io.schema.rules.uint32.lte": "9216"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 64,
"maximum": 9216,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site from which ping is initiated.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site from which ping is initiated.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for pingPingRequest",
"required_fields": [
"node"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for pingPingRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  node: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"node\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"avg_rtt": {
"type": "string"
},
"dest": {
"type": "string"
},
"lost": {
"type": "integer"
},
"max_rtt": {
"type": "string"
},
"min_rtt": {
"type": "string"
},
"received": {
"type": "integer"
},
"sent": {
"type": "integer"
},
"std_dev_rtt": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"node": "value"
}
},
"requiredFields": [
"node"
],
"description": "Minimum configuration for pingPingRequest"
},
"fieldMetadata": {
"count": {
"type": "integer",
"description": "Number of ping requests to be sent.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 64,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest": {
"type": "object",
"description": "Host Identifier identifies a host, either by its DNS name (hostname) or by its IP address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest.hostname": {
"type": "string",
"description": "Exclusive with [IP]\nDNS name of the host.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "hostname",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest.ip": {
"type": "string",
"description": "Exclusive with [hostname]\nIP address of the host.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"interval": {
"type": "integer",
"description": "Interval between ping requests, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 300,
"maximum": 10000,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"intf": {
"type": "object",
"description": "Interface Identifier identifies one or all interfaces on a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.any_intf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.intf": {
"type": "string",
"description": "Exclusive with [any_intf]\nName of the chosen interface on the node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node from which ping is initiated.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pkt_size": {
"type": "integer",
"description": "Ping packet size.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 64,
"maximum": 9216,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site from which ping is initiated.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"dest.hostname_or_ip": [
"hostname",
"ip"
],
"intf.interface_choice": [
"any_intf",
"intf"
]
},
"responseSummary": [
{
"field": "avg_rtt",
"type": "string",
"description": "Average round trip time."
},
{
"field": "dest",
"type": "string",
"description": "Destination address used for ping."
},
{
"field": "lost",
"type": "integer",
"description": "Number of packets lost."
},
{
"field": "max_rtt",
"type": "string",
"description": "Maximum round trip time."
},
{
"field": "min_rtt",
"type": "string",
"description": "Minimum round trip time."
},
{
"field": "received",
"type": "integer",
"description": "Number of responses received."
},
{
"field": "sent",
"type": "integer",
"description": "Number of packets sent."
},
{
"field": "std_dev_rtt",
"type": "string",
"description": "Standard Deviation RTT."
}
]
}
]
},
	"operate-ver-resync-crl": {
"name": "operate-ver-resync-crl",
"displayName": "Operate Ver Resync Crl",
"operations": [
{
"name": "create_operate_ver_resync_crl",
"description": "Resync CRL.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/resync_crl",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to trigger resync of CRL in VER.",
"title": "Resync CRL Request",
"x-displayname": "Resync CRL Request.",
"x-ves-oneof-field-crl_id_choice": "[\"name\",\"uid\"]",
"x-ves-proto-message": "ves.io.schema.operate.crl.ResyncCRLRequest",
"properties": {
"name": {
"type": "string",
"description": "Exclusive with [uid]\nName of the CRL object.",
"title": "CRL Name",
"x-displayname": "CRL Name",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "Exclusive with [uid] Name of the CRL object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"site": {
"type": "string",
"description": "Name of the site for which request is sent.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site for which request is sent.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"uid": {
"type": "string",
"description": "Exclusive with [name]\nUID of the CRL object.",
"title": "CRL UID",
"x-displayname": "CRL UID",
"x-f5xc-description-short": "Exclusive with [name] UID of the CRL object.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only",
"format": "uuid",
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to trigger resync of CRL in VER.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for crlResyncCRLRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for crlResyncCRLRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for crlResyncCRLRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Exclusive with [uid]\nName of the CRL object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which request is sent.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"uid": {
"type": "string",
"description": "Exclusive with [name]\nUID of the CRL object.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"crl_id_choice": [
"name",
"uid"
]
},
"responseSummary": [
{
"field": "status",
"type": "string",
"description": "Status of the CRL request."
}
]
}
]
},
	"operate-ver-routes": {
"name": "operate-ver-routes",
"displayName": "Operate Ver Routes",
"operations": [
{
"name": "create_operate_ver_route",
"description": "Show Routes.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/routes",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET list of VER routes matching the request.",
"title": "Route Request",
"x-displayname": "Route Request.",
"x-ves-oneof-field-cluster_node_choice": "[\"cluster_wide\",\"node\"]",
"x-ves-oneof-field-network_choice": "[\"segment\",\"vn\",\"vn_type\"]",
"x-ves-proto-message": "ves.io.schema.operate.route.RouteRequest",
"properties": {
"cluster_wide": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"family": {
"allOf": [
{
"$ref": "#/components/schemas/routeRouteFamily"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Exclusive with [cluster_wide]\nFetch routes from this node.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Exclusive with [cluster_wide] Fetch routes from this node.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"prefix": {
"allOf": [
{
"$ref": "#/components/schemas/schemaPrefixListType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"segment": {
"type": "string",
"description": "Exclusive with [vn vn_type]\nName of Segment for which routes are required.",
"title": "Segment name",
"x-displayname": "Segment Name.",
"x-ves-example": "Test-segment.",
"x-f5xc-example": "test-segment",
"x-f5xc-description-short": "Exclusive with [vn vn_type] Name of Segment for which routes are required.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which request is sent.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site for which request is sent.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn": {
"type": "string",
"description": "Exclusive with [segment vn_type]\nName of Virtual Network for which routes are required.",
"title": "Virtual Network Name",
"x-displayname": "Virtual Network Name.",
"x-ves-example": "Site-local-outside-vn.",
"x-f5xc-example": "site-local-outside-vn",
"x-f5xc-description-short": "Exclusive with [segment vn_type] Name of Virtual Network for which routes are required.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn_type": {
"allOf": [
{
"$ref": "#/components/schemas/schemaVirtualNetworkType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET list of VER routes matching the request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for routeRouteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for routeRouteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {
"ver_routes": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for routeRouteRequest"
},
"fieldMetadata": {
"cluster_wide": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"family": {
"type": "string",
"description": "Address family for which routes are requested\n\nIPv4 Routes\nIPv6 Routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INET4"
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Exclusive with [cluster_wide]\nFetch routes from this node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"prefix": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"prefix.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"segment": {
"type": "string",
"description": "Exclusive with [vn vn_type]\nName of Segment for which routes are required.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which request is sent.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn": {
"type": "string",
"description": "Exclusive with [segment vn_type]\nName of Virtual Network for which routes are required.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vn_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
}
},
"oneOfVariants": {
"cluster_node_choice": [
"cluster_wide",
"node"
],
"network_choice": [
"segment",
"vn",
"vn_type"
]
},
"responseSummary": [
{
"field": "ver_routes",
"type": "array",
"description": "Routes from ver instance."
}
]
}
]
},
	"operate-ver-simplified-routes": {
"name": "operate-ver-simplified-routes",
"displayName": "Operate Ver Simplified Routes",
"operations": [
{
"name": "create_operate_ver_simplified_route",
"description": "Show Simplified Routes.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET list of VER routes matching the request.",
"title": "SimplifiedRoute Request",
"x-displayname": "Simplified Route Request.",
"x-ves-oneof-field-cluster_node_choice": "[\"all_nodes\",\"node\"]",
"x-ves-oneof-field-network_choice": "[\"global_network\",\"segment\",\"sli\",\"slo\"]",
"x-ves-proto-message": "ves.io.schema.operate.route.SimplifiedRouteRequest",
"properties": {
"all_nodes": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"family": {
"allOf": [
{
"$ref": "#/components/schemas/routeRouteFamily"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"global_network": {
"type": "string",
"description": "Exclusive with [segment sli slo]\nName of the Global Network for which routes are required.",
"title": "Global Network Name",
"x-displayname": "Global Network Name.",
"x-ves-example": "Mcn-global-network.",
"x-f5xc-example": "mcn-global-network",
"x-f5xc-description-short": "Exclusive with [segment sli slo] Name of the Global Network for which routes are required.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Exclusive with [all_nodes]\nFetch routes from this node.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Exclusive with [all_nodes] Fetch routes from this node.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"prefix": {
"allOf": [
{
"$ref": "#/components/schemas/schemaPrefixListType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"segment": {
"type": "string",
"description": "Exclusive with [global_network sli slo]\nName of Segment for which routes are required.",
"title": "Segment name",
"x-displayname": "Segment Name.",
"x-ves-example": "Test-segment.",
"x-f5xc-example": "test-segment",
"x-f5xc-description-short": "Exclusive with [global_network sli slo] Name of Segment for which routes are required.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which request is sent.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site for which request is sent.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sli": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"slo": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET list of VER routes matching the request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for routeSimplifiedRouteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for routeSimplifiedRouteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {
"ver_routes": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for routeSimplifiedRouteRequest"
},
"fieldMetadata": {
"all_nodes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"family": {
"type": "string",
"description": "Address family for which routes are requested\n\nIPv4 Routes\nIPv6 Routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INET4"
},
"global_network": {
"type": "string",
"description": "Exclusive with [segment sli slo]\nName of the Global Network for which routes are required.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Exclusive with [all_nodes]\nFetch routes from this node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"prefix": {
"type": "object",
"description": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"prefix.prefix": {
"type": "array",
"description": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"segment": {
"type": "string",
"description": "Exclusive with [global_network sli slo]\nName of Segment for which routes are required.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which request is sent.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sli": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"slo": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"cluster_node_choice": [
"all_nodes",
"node"
],
"network_choice": [
"global_network",
"segment",
"sli",
"slo"
]
},
"responseSummary": [
{
"field": "ver_routes",
"type": "array",
"description": "Routes from ver instance."
}
]
}
]
},
	"operate-ver-stop-tcpdump": {
"name": "operate-ver-stop-tcpdump",
"displayName": "Operate Ver Stop Tcpdump",
"operations": [
{
"name": "create_operate_ver_stop_tcpdump",
"description": "Stop Tcpdump.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/stop_tcpdump",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch captured pcap data from an earlier Tcpdump request.",
"title": "PCAP Fetch Request",
"x-displayname": "PCAP Fetch Request.",
"x-ves-displayorder": "1,2,3,5",
"x-ves-proto-message": "ves.io.schema.operate.tcpdump.FetchRequest",
"properties": {
"intf": {
"allOf": [
{
"$ref": "#/components/schemas/schemaInterfaceOrNetwork"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node on which Tcpdump was run.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node on which Tcpdump was run.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which Tcpdump was run.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site on which Tcpdump was run.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to fetch captured pcap data from an earlier Tcpdump request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tcpdumpFetchRequest",
"required_fields": [
"node"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tcpdumpFetchRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  node: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"node\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"node": "value"
}
},
"requiredFields": [
"node"
],
"description": "Minimum configuration for tcpdumpFetchRequest"
},
"fieldMetadata": {
"intf": {
"type": "object",
"description": "Selects an interface on a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.intf": {
"type": "string",
"description": "Exclusive with [pod vn vn_type]\nName of the chosen interface on the node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.pod": {
"type": "string",
"description": "Exclusive with [intf vn vn_type]\nName of the pod whose interface on the node is chosen.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.vn": {
"type": "string",
"description": "Exclusive with [intf pod vn_type]\nName of chosen Virtual Network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.vn_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node on which Tcpdump was run.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which Tcpdump was run.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"intf.interface_choice": [
"intf",
"pod",
"vn",
"vn_type"
]
}
}
]
},
	"operate-ver-tcpdump": {
"name": "operate-ver-tcpdump",
"displayName": "Operate Ver Tcpdump",
"operations": [
{
"name": "create_operate_ver_tcpdump",
"description": "Tcpdump",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/tcpdump",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to run tcpdump on a ver interface.",
"title": "Tcpdump Request",
"x-displayname": "Tcpdump Request.",
"x-ves-displayorder": "1,2,3,8,5,6,7",
"x-ves-proto-message": "ves.io.schema.operate.tcpdump.TcpdumpRequest",
"properties": {
"count": {
"type": "integer",
"description": "Maximum packets to be captured.\nPacket capture will end once this number of packets are captured.",
"title": "Count",
"format": "int64",
"x-displayname": "Count",
"x-ves-example": "100",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "32768"
},
"x-f5xc-example": "100",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "32768"
},
"x-f5xc-description-short": "Maximum packets to be captured. Packet capture will end once this number of packets are captured.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 32768,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf": {
"allOf": [
{
"$ref": "#/components/schemas/schemaInterfaceOrNetwork"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"max_time_period": {
"type": "integer",
"description": "Maximum time period, in seconds, for which packets are to be captured on the interface.\nPacket capture will end after this time period, irrespective of the number of packets captured.",
"title": "Maximum Time Period",
"format": "int64",
"x-displayname": "Maximum Time Period.",
"x-ves-example": "300",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "1800"
},
"x-f5xc-example": "300",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "1800"
},
"x-f5xc-description-short": "Maximum time period, in seconds, for which packets are to be captured on the interface.",
"x-f5xc-description-medium": "Maximum time period, in seconds, for which packets are to be captured on the interface. Packet capture will end after this time period, irrespective of the number of packets captured.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node on which tcpdump is initiated.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node on which tcpdump is initiated.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"options": {
"type": "string",
"description": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump.\nThese filter rules will be in the same format as linux tcpdump filter rules.",
"title": "Options",
"minLength": 1,
"maxLength": 256,
"x-displayname": "OPTIONS",
"x-ves-example": "-ne TCP port 80.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "-ne tcp port 80",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump. These filter rules will be in the same format as linux tcpdump filter rules.",
"x-f5xc-description-medium": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump. These filter rules will be in the same format as linux tcpdump filter rules.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which tcpdump is to be run.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site on which tcpdump is to be run.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to run tcpdump on a ver interface.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tcpdumpTcpdumpRequest",
"required_fields": [
"node"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tcpdumpTcpdumpRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  node: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"node\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"duration": {
"type": "integer"
},
"interface_name": {
"type": "string"
},
"node": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"node": "value"
}
},
"requiredFields": [
"node"
],
"description": "Minimum configuration for tcpdumpTcpdumpRequest"
},
"fieldMetadata": {
"count": {
"type": "integer",
"description": "Maximum packets to be captured.\nPacket capture will end once this number of packets are captured.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 32768,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf": {
"type": "object",
"description": "Selects an interface on a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.intf": {
"type": "string",
"description": "Exclusive with [pod vn vn_type]\nName of the chosen interface on the node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.pod": {
"type": "string",
"description": "Exclusive with [intf vn vn_type]\nName of the pod whose interface on the node is chosen.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.vn": {
"type": "string",
"description": "Exclusive with [intf pod vn_type]\nName of chosen Virtual Network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.vn_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
},
"max_time_period": {
"type": "integer",
"description": "Maximum time period, in seconds, for which packets are to be captured on the interface.\nPacket capture will end after this time period, irrespective of the number of packets captured.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node on which tcpdump is initiated.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"options": {
"type": "string",
"description": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump.\nThese filter rules will be in the same format as linux tcpdump filter rules.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site on which tcpdump is to be run.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"intf.interface_choice": [
"intf",
"pod",
"vn",
"vn_type"
]
},
"responseSummary": [
{
"field": "count",
"type": "integer",
"description": "Packet capture will end once count reaches, irrespective of time duration is still present."
},
{
"field": "duration",
"type": "integer",
"description": "Duration in seconds, for which packets are captured on the interface.\nPacket capture will end after this duration, irrespective of the number of packets captured."
},
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "interface_name",
"type": "string",
"description": "Interface Name on which tcpdump is triggered."
},
{
"field": "node",
"type": "string",
"description": "Name of the node on which tcpdump is initiated."
},
{
"field": "status",
"type": "string",
"description": "Status Response for TcpdumpRequest job."
}
]
}
]
},
	"operate-ver-traceroute": {
"name": "operate-ver-traceroute",
"displayName": "Operate Ver Traceroute",
"operations": [
{
"name": "create_operate_ver_traceroute",
"description": "Traceroute.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/traceroute",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to run traceroute to a destination.",
"title": "Traceroute Request",
"x-displayname": "Traceroute Request.",
"x-ves-proto-message": "ves.io.schema.operate.traceroute.TracerouteRequest",
"properties": {
"dest": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHostIdentifier"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"hops": {
"type": "integer",
"description": "Maximum number of hops (TTL) for probe packets.",
"title": "Hops",
"format": "int64",
"x-displayname": "Hops",
"x-ves-example": "16",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "64"
},
"x-f5xc-example": "16",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "64"
},
"x-f5xc-description-short": "Maximum number of hops (TTL) for probe packets.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf": {
"allOf": [
{
"$ref": "#/components/schemas/schemaInterfaceIdentifier"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node from which traceroute is initiated.",
"title": "Node Name",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "64",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-description-short": "Name of the node from which traceroute is initiated.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"retries": {
"type": "integer",
"description": "Number of probes for each hop.",
"title": "Retries",
"format": "int64",
"x-displayname": "Retries",
"x-ves-example": "3",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "8"
},
"x-f5xc-example": "3",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "8"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 8,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site from which traceroute is initiated.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the site from which traceroute is initiated.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to run traceroute to a destination.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tracerouteTracerouteRequest",
"required_fields": [
"node"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tracerouteTracerouteRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  node: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"node\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {
"hops": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"node": "value"
}
},
"requiredFields": [
"node"
],
"description": "Minimum configuration for tracerouteTracerouteRequest"
},
"fieldMetadata": {
"dest": {
"type": "object",
"description": "Host Identifier identifies a host, either by its DNS name (hostname) or by its IP address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest.hostname": {
"type": "string",
"description": "Exclusive with [IP]\nDNS name of the host.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$",
"format": "hostname",
"validation": {
"rfc": "RFC 1123"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest.ip": {
"type": "string",
"description": "Exclusive with [hostname]\nIP address of the host.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"hops": {
"type": "integer",
"description": "Maximum number of hops (TTL) for probe packets.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf": {
"type": "object",
"description": "Interface Identifier identifies one or all interfaces on a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.any_intf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"intf.intf": {
"type": "string",
"description": "Exclusive with [any_intf]\nName of the chosen interface on the node.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node from which traceroute is initiated.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"retries": {
"type": "integer",
"description": "Number of probes for each hop.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 8,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site from which traceroute is initiated.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"dest.hostname_or_ip": [
"hostname",
"ip"
],
"intf.interface_choice": [
"any_intf",
"intf"
]
},
"responseSummary": [
{
"field": "hops",
"type": "array",
"description": "All the hops in traceroute response."
}
]
}
]
},
	"operate-vpm-debug-exec": {
"name": "operate-vpm-debug-exec",
"displayName": "Operate Vpm Debug Exec",
"operations": [
{
"name": "create_operate_vpm_debug_exec",
"description": "Exec",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/exec",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to execute CLI command on a specific node in site.",
"title": "Exec Request",
"x-displayname": "Exec Request.",
"x-ves-proto-message": "ves.io.schema.operate.debug.ExecRequest",
"properties": {
"command": {
"type": "array",
"description": "Command to execute.",
"title": "Command",
"items": {
"type": "string"
},
"x-displayname": "Command",
"x-f5xc-example": "[\"nslookup\", \"google.com\"]",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"console_user": {
"type": "string",
"description": "Name of the console user who runs this command.",
"title": "User",
"x-displayname": "User",
"x-ves-example": "Console-user.",
"x-f5xc-example": "console-user",
"x-f5xc-description-short": "Name of the console user who runs this command.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to execute CLI command on a specific node in site.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugExecRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugExecRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"output": {
"type": "string"
},
"return_code": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for debugExecRequest"
},
"fieldMetadata": {
"command": {
"type": "array",
"description": "Command to execute.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"console_user": {
"type": "string",
"description": "Name of the console user who runs this command.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "output",
"type": "string",
"description": "Output of the requested command."
},
{
"field": "return_code",
"type": "integer",
"description": "Return code of requested command."
}
]
}
]
},
	"operate-vpm-debug-exec-log": {
"name": "operate-vpm-debug-exec-log",
"displayName": "Operate Vpm Debug Exec Log",
"operations": [
{
"name": "list_operate_vpm_debug_exec_log",
"description": "Exec Log",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/exec-log",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "line_count",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"exec_log": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "exec_log",
"type": "string",
"description": "Exec Log output from specific service."
}
]
}
]
},
	"operate-vpm-debug-exec-user": {
"name": "operate-vpm-debug-exec-user",
"displayName": "Operate Vpm Debug Exec User",
"operations": [
{
"name": "create_operate_vpm_debug_exec_user",
"description": "ExecUser",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/exec-user",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to execute CLI command on a specific node in site.",
"title": "Exec Request",
"x-displayname": "Exec Request.",
"x-ves-proto-message": "ves.io.schema.operate.debug.ExecRequest",
"properties": {
"command": {
"type": "array",
"description": "Command to execute.",
"title": "Command",
"items": {
"type": "string"
},
"x-displayname": "Command",
"x-f5xc-example": "[\"nslookup\", \"google.com\"]",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"console_user": {
"type": "string",
"description": "Name of the console user who runs this command.",
"title": "User",
"x-displayname": "User",
"x-ves-example": "Console-user.",
"x-f5xc-example": "console-user",
"x-f5xc-description-short": "Name of the console user who runs this command.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to execute CLI command on a specific node in site.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugExecRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugExecRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"output": {
"type": "string"
},
"return_code": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for debugExecRequest"
},
"fieldMetadata": {
"command": {
"type": "array",
"description": "Command to execute.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"console_user": {
"type": "string",
"description": "Name of the console user who runs this command.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "output",
"type": "string",
"description": "Output of the requested command."
},
{
"field": "return_code",
"type": "integer",
"description": "Return code of requested command."
}
]
}
]
},
	"operate-vpm-debug-global-list-service": {
"name": "operate-vpm-debug-global-list-service",
"displayName": "Operate Vpm Debug Global List Service",
"operations": [
{
"name": "list_operate_vpm_debug_global_list_service",
"description": "List F5XC services.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/global/list-service",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"service": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "service",
"type": "array",
"description": "List of services from site."
}
]
}
]
},
	"operate-vpm-debug-global-status": {
"name": "operate-vpm-debug-global-status",
"displayName": "Operate Vpm Debug Global Status",
"operations": [
{
"name": "list_operate_vpm_debug_global_status",
"description": "Status",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/global/{vesnamespace}/status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "vesnamespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "cached",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "status",
"type": "array",
"description": "List of status from site."
}
]
}
]
},
	"operate-vpm-debug-host-ping": {
"name": "operate-vpm-debug-host-ping",
"displayName": "Operate Vpm Debug Host Ping",
"operations": [
{
"name": "create_operate_vpm_debug_host_ping",
"description": "Host Ping",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/host-ping",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to initiate ping from the site.",
"title": "Host Ping Request",
"x-displayname": "Host Ping Request.",
"x-ves-proto-message": "ves.io.schema.operate.debug.HostPingRequest",
"properties": {
"count": {
"type": "integer",
"description": "Number of ping requests.",
"title": "Count",
"format": "int32",
"x-displayname": "Count",
"x-ves-example": "3",
"x-f5xc-example": "3",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "general",
"minimum": 0,
"maximum": 10000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.7,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest": {
"type": "string",
"description": "Destination to ping can be IP Address or DNS name.",
"title": "Destination",
"x-displayname": "Destination.",
"x-ves-example": "google.com.",
"x-f5xc-example": "google.com",
"x-f5xc-description-short": "Destination to ping can be IP Address or DNS name.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"interval": {
"type": "integer",
"description": "Interval is the wait time between each packet send. Default is 1s (1000ms).",
"title": "Interval",
"format": "int32",
"x-displayname": "Interval",
"x-ves-example": "1000",
"x-f5xc-example": "1000",
"x-f5xc-description-short": "Interval is the wait time between each packet send. Default is 1s (1000ms).",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "timing",
"minimum": 1,
"maximum": 600,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"length": {
"type": "integer",
"description": "Size of packet being sent.",
"title": "Length",
"format": "int32",
"x-displayname": "Size",
"x-ves-example": "56",
"x-f5xc-example": "56",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugHostPingRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugHostPingRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"avg_rtt": {
"type": "string"
},
"dest_ip": {
"type": "string"
},
"lost": {
"type": "integer"
},
"max_rtt": {
"type": "string"
},
"min_rtt": {
"type": "string"
},
"received": {
"type": "integer"
},
"sent": {
"type": "integer"
},
"std_dev_rtt": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for debugHostPingRequest"
},
"fieldMetadata": {
"count": {
"type": "integer",
"description": "Number of ping requests.",
"constraints": {
"constraintType": "number",
"category": "general",
"minimum": 0,
"maximum": 10000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.7,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dest": {
"type": "string",
"description": "Destination to ping can be IP Address or DNS name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"interval": {
"type": "integer",
"description": "Interval is the wait time between each packet send. Default is 1s (1000ms).",
"constraints": {
"constraintType": "number",
"category": "timing",
"minimum": 1,
"maximum": 600,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"length": {
"type": "integer",
"description": "Size of packet being sent.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "avg_rtt",
"type": "string",
"description": "AvgRtt is the average round-trip time."
},
{
"field": "dest_ip",
"type": "string",
"description": "Destination IP is the address of the host being pinged."
},
{
"field": "lost",
"type": "integer",
"description": "Lost is the percentage of packets lost."
},
{
"field": "max_rtt",
"type": "string",
"description": "MaxRtt is the maximum round-trip time."
},
{
"field": "min_rtt",
"type": "string",
"description": "MinRtt is the minimum round-trip time."
},
{
"field": "received",
"type": "integer",
"description": "Received is the number of packets received."
},
{
"field": "sent",
"type": "integer",
"description": "Sent is the number of packets sent."
},
{
"field": "std_dev_rtt",
"type": "string",
"description": "StdDevRtt is the standard deviation of the round-trip times."
}
]
}
]
},
	"operate-vpm-debug-log": {
"name": "operate-vpm-debug-log",
"displayName": "Operate Vpm Debug Log",
"operations": [
{
"name": "list_operate_vpm_debug_log",
"description": "Log",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/{service}/log",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "service",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "last_lines",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"log": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "log",
"type": "string",
"description": "Log output from specific service."
}
]
}
]
},
	"operate-vpm-debug-reboot": {
"name": "operate-vpm-debug-reboot",
"displayName": "Operate Vpm Debug Reboot",
"operations": [
{
"name": "create_operate_vpm_debug_reboot",
"description": "Reboot node.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/reboot",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to reboot specific node in site.",
"title": "Reboot Request",
"x-displayname": "Reboot Request.",
"x-ves-proto-message": "ves.io.schema.operate.debug.RebootRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to reboot specific node in site.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugRebootRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugRebootRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for debugRebootRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-vpm-debug-soft-restart": {
"name": "operate-vpm-debug-soft-restart",
"displayName": "Operate Vpm Debug Soft Restart",
"operations": [
{
"name": "create_operate_vpm_debug_soft_restart",
"description": "Soft restart.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/{service}/soft-restart",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "service",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to soft restart reloads VER instance on the node.",
"title": "Soft restart Request",
"x-displayname": "Soft restart Request.",
"x-ves-proto-message": "ves.io.schema.operate.debug.SoftRestartRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"service": {
"type": "string",
"description": "Name of the service.",
"title": "Service Name",
"x-displayname": "Service Name.",
"x-ves-example": "Vpm",
"x-f5xc-example": "vpm",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to soft restart reloads VER instance on the node.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for debugSoftRestartRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for debugSoftRestartRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for debugSoftRestartRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"service": {
"type": "string",
"description": "Name of the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-vpm-lte": {
"name": "operate-vpm-lte",
"displayName": "Operate Vpm Lte",
"operations": [
{
"name": "list_operate_vpm_lte",
"description": "GET LTE configuration.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/lte/{node}/config",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "config",
"type": "object",
"description": ""
}
]
},
{
"name": "create_operate_vpm_lte",
"description": "Update LTE configuration.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/lte/{node}/config",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Updates LTE configuration.",
"title": "LTE Update Config Request",
"x-displayname": "LTE Update Config Request.",
"x-ves-proto-message": "ves.io.schema.operate.lte.LteUpdateConfigRequest",
"properties": {
"config": {
"allOf": [
{
"$ref": "#/components/schemas/lteLteConfig"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for lteLteUpdateConfigRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for lteLteUpdateConfigRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for lteLteUpdateConfigRequest"
},
"fieldMetadata": {
"config": {
"type": "object",
"description": "Configuration of LTE.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.apn": {
"type": "string",
"description": "Access Point Name is the name of a gateway between a mobile network and another computer network.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.password": {
      "type": "string",
"description": "Password for LTE connection.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.pin": {
"type": "string",
"description": "Pin for LTE connection.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.primary": {
"type": "boolean",
"description": "LTE interface is used as Primary Site Local Outside.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.user": {
"type": "string",
"description": "Username for LTE connection.",
"constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-vpm-lte-disconnect": {
"name": "operate-vpm-lte-disconnect",
"displayName": "Operate Vpm Lte Disconnect",
"operations": [
{
"name": "create_operate_vpm_lte_disconnect",
"description": "Disconnect.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/lte/{node}/disconnect",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET Disconnect from LTE.",
"title": "LTE Disconnect Request",
"x-displayname": "LTE Disconnect Request.",
"x-ves-proto-message": "ves.io.schema.operate.lte.LteDisconnectRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for lteLteDisconnectRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for lteLteDisconnectRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for lteLteDisconnectRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-vpm-lte-info": {
"name": "operate-vpm-lte-info",
"displayName": "Operate Vpm Lte Info",
"operations": [
{
"name": "list_operate_vpm_lte_info",
"description": "Show LTE info.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/lte/{node}/info",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "lte_info",
"type": "object",
"description": ""
}
]
}
]
},
	"operate-vpm-usb": {
"name": "operate-vpm-usb",
"displayName": "Operate Vpm Usb",
"operations": [
{
"name": "list_operate_vpm_usb",
"description": "GET USB configuration.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/config",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "config",
"type": "object",
"description": ""
}
]
},
{
"name": "create_operate_vpm_usb",
"description": "Update USB configuration.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/config",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Updates USB configuration.",
"title": "USB Update Config Request",
"x-displayname": "USB Update Config Request.",
"x-ves-proto-message": "ves.io.schema.operate.usb.UsbUpdateConfigRequest",
"properties": {
"config": {
"allOf": [
{
"$ref": "#/components/schemas/usbUsbConfig"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usbUsbUpdateConfigRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usbUsbUpdateConfigRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usbUsbUpdateConfigRequest"
},
"fieldMetadata": {
"config": {
"type": "object",
"description": "Usb config.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.usb_allow_list_enable": {
"type": "boolean",
"description": "Enablement of USB rules list. If enabled, all new connected USB devices must be authorized.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-vpm-usb-list": {
"name": "operate-vpm-usb-list",
"displayName": "Operate Vpm Usb List",
"operations": [
{
"name": "list_operate_vpm_usb_list",
"description": "List USB devices.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/list",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"node": {
"type": "string"
},
"site": {
"type": "string"
},
"usb": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "namespace",
"type": "string",
"description": "Namespace for which the request is sent (system)"
},
{
"field": "node",
"type": "string",
"description": "Name of the node."
},
{
"field": "site",
"type": "string",
"description": "Name of the site."
},
{
"field": "usb",
"type": "array",
"description": "List of USB devices in server."
}
]
}
]
},
	"operate-vpm-usb-rules": {
"name": "operate-vpm-usb-rules",
"displayName": "Operate Vpm Usb Rules",
"operations": [
{
"name": "list_operate_vpm_usb_rules",
"description": "List USB Enablement Rules.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"rules": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "rules",
"type": "array",
"description": "List of USB Enablement Rules."
}
]
}
]
},
	"operate-vpm-usb-rules-add": {
"name": "operate-vpm-usb-rules-add",
"displayName": "Operate Vpm Usb Rules Add",
"operations": [
{
"name": "create_operate_vpm_usb_rules_add",
"description": "Add USB Enablement Rules.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/rules/add",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to add USB Enablement Rules.",
"title": "USB Add Rules Request",
"x-displayname": "USB Add Rules Request.",
"x-ves-proto-message": "ves.io.schema.operate.usb.UsbAddRulesRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rules": {
"type": "array",
"description": "Add of USB Enablement Rules.",
"title": "Rules",
"items": {
"$ref": "#/components/schemas/usb_policyRule"
},
"x-displayname": "USB Enablement Rules.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "policy",
"minItems": 0,
"maxItems": 100,
"uniqueItems": false,
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usbUsbAddRulesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usbUsbAddRulesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"rules": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usbUsbAddRulesRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rules": {
"type": "array",
"description": "Add of USB Enablement Rules.",
"constraints": {
"constraintType": "array",
"category": "policy",
"minItems": 0,
"maxItems": 100,
"uniqueItems": false,
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "rules",
"type": "array",
"description": "Added USB Enablement Rules."
}
]
}
]
},
	"operate-vpm-usb-rules-delete": {
"name": "operate-vpm-usb-rules-delete",
"displayName": "Operate Vpm Usb Rules Delete",
"operations": [
{
"name": "create_operate_vpm_usb_rules_delete",
"description": "DELETE USB Enablement Rules.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/rules/delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to DELETE USB Enablement Rules.",
"title": "USB Delete Rules Request",
"x-displayname": "USB DELETE Rules Request.",
"x-ves-proto-message": "ves.io.schema.operate.usb.UsbDeleteRulesRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rules": {
"type": "array",
"description": "DELETE of USB Enablement Rules.",
"title": "Rules",
"items": {
"$ref": "#/components/schemas/usb_policyRule"
},
"x-displayname": "USB Enablement Rules.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "policy",
"minItems": 0,
"maxItems": 100,
"uniqueItems": false,
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usbUsbDeleteRulesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usbUsbDeleteRulesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"rules": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usbUsbDeleteRulesRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rules": {
"type": "array",
"description": "DELETE of USB Enablement Rules.",
"constraints": {
"constraintType": "array",
"category": "policy",
"minItems": 0,
"maxItems": 100,
"uniqueItems": false,
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "rules",
"type": "array",
"description": "Deleted USB Enablement Rules."
}
]
}
]
},
	"operate-vpm-wifi": {
"name": "operate-vpm-wifi",
"displayName": "Operate Vpm Wifi",
"operations": [
{
"name": "list_operate_vpm_wifi",
"description": "GET WIFI configuration.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/wifi/{node}/config",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "config",
"type": "object",
"description": ""
}
]
},
{
"name": "create_operate_vpm_wifi",
"description": "Update WIFI configuration.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/wifi/{node}/config",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Updates WIFI configuration.",
"title": "WIFI Update Config Request",
"x-displayname": "WIFI Update Config Request.",
"x-ves-proto-message": "ves.io.schema.operate.wifi.WifiUpdateConfigRequest",
"properties": {
"config": {
"allOf": [
{
"$ref": "#/components/schemas/wifiWifiConfig"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for wifiWifiUpdateConfigRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for wifiWifiUpdateConfigRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for wifiWifiUpdateConfigRequest"
},
"fieldMetadata": {
"config": {
"type": "object",
"description": "Configuration of WIFI.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.none": {
"type": "object",
"description": "WIFI without any security mechanism.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.ssid": {
"type": "string",
"description": "The service set identifier, or \"network name\" of the BSS.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.wpa2_personal": {
"type": "object",
"description": "WIFI WPA2 Personal security mechanism.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config.wpa2_personal.password": {
      "type": "string",
"description": "WIFI Password.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"config.security": [
"none",
"wpa2_personal"
]
}
}
]
},
	"operate-vpm-wifi-disconnect": {
"name": "operate-vpm-wifi-disconnect",
"displayName": "Operate Vpm Wifi Disconnect",
"operations": [
{
"name": "create_operate_vpm_wifi_disconnect",
"description": "Disconnect.",
"method": "POST",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/wifi/{node}/disconnect",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET Disconnect from WIFI.",
"title": "WIFI Disconnect Request",
"x-displayname": "WIFI Disconnect Request.",
"x-ves-proto-message": "ves.io.schema.operate.wifi.WifiDisconnectRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node": {
"type": "string",
"description": "Name of the node.",
"title": "Node Name",
"x-displayname": "Node Name",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site Name",
"x-displayname": "Site Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for wifiWifiDisconnectRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for wifiWifiDisconnectRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for wifiWifiDisconnectRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for which the request is sent (system)",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node": {
"type": "string",
"description": "Name of the node.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"operate-vpm-wifi-info": {
"name": "operate-vpm-wifi-info",
"displayName": "Operate Vpm Wifi Info",
"operations": [
{
"name": "list_operate_vpm_wifi_info",
"description": "Show WIFI info.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/wifi/{node}/info",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "wifi_info",
"type": "object",
"description": ""
}
]
}
]
},
	"operate-vpm-wifi-list": {
"name": "operate-vpm-wifi-list",
"displayName": "Operate Vpm Wifi List",
"operations": [
{
"name": "list_operate_vpm_wifi_list",
"description": "List WIFI networks.",
"method": "GET",
"path": "/api/operate/namespaces/{namespace}/sites/{site}/vpm/wifi/{node}/list",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "node",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"wifi_item": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "wifi_item",
"type": "array",
"description": "List of available WIFI networks to connect from wifi scan."
}
]
}
]
},
	"origin-pools": {
"name": "origin-pools",
"displayName": "Origin Pools",
"operations": [
{
"name": "create_origin_pool",
"description": "Create Origin Pool.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/origin_pools",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of origin_pool",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.origin_pool.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/viewsorigin_poolCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Backend origin servers or load balancing pool for distributing traffic",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.origin_servers",
"spec.port"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: origin_pool\nmetadata:\n  name: backend-pool\n  namespace: default\nspec:\n  origin_servers:\n    - public_name:\n        dns_name: backend1.example.com\n    - public_name:\n        dns_name: backend2.example.com\n  port: 8080\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"backend-pool\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"origin_servers\": [\n      {\"public_name\": {\"dns_name\": \"backend1.example.com\"}},\n      {\"public_name\": {\"dns_name\": \"backend2.example.com\"}}\n    ],\n    \"port\": 8080\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "backend-pool",
"namespace": "default"
},
"spec": {
"origin_servers": [
{
"public_name": {
"dns_name": "backend1.example.com"
}
},
{
"public_name": {
"dns_name": "backend2.example.com"
}
}
],
"port": 8080
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.origin_servers",
"spec.port"
],
"description": "Backend origin servers or load balancing pool for distributing traffic"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the origin pool create specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advanced_options": {
"type": "object",
"description": "Configure Advanced OPTIONS for origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.auto_http_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.circuit_breaker": {
"type": "object",
"description": "CircuitBreaker provides a mechanism for watching failures in upstream connections or requests\nand if the failures reach a certain threshold, automatically fail subsequent requests which\nallows to apply back pressure on downstream quickly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to endpoints in the cluster.\nThis is specified in milliseconds. The default value is 2 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.default_circuit_breaker": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_circuit_breaker": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_lb_source_ip_persistence": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "disable_lb_source_ip_persistance"
},
"spec.advanced_options.disable_outlier_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_proxy_protocol": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_subsets": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.enable_lb_source_ip_persistence": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "enable_lb_source_ip_persistance"
},
"spec.advanced_options.enable_subsets": {
"type": "object",
"description": "Configure subset OPTIONS for origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.http1_config": {
"type": "object",
"description": "HTTP/1.1 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.http2_options": {
"type": "object",
"description": "Http2 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.http_idle_timeout": {
"type": "integer",
"description": "The idle timeout for upstream connection pool connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 5 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\nSets the maximum number of requests allowed per connection to the origin server.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.no_panic_threshold": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.outlier_detection": {
"type": "object",
"description": "Outlier detection and ejection is the process of dynamically determining whether some number\nof hosts in an upstream cluster are performing unlike the others and removing them from the\nhealthy load balancing set. Outlier detection is a form of passive health checking.\n\nAlgorithm\n\n1. A endpoint is determined to be an outlier (based on configured number of consecutive_5xx\nor consecutive_gateway_failures) .\n2. If no endpoints have been ejected, loadbalancer will eject the host immediately.\nOtherwise, it checks to make sure the number of ejected hosts is below the allowed threshold\n(specified via max_ejection_percent setting). If the number of ejected hosts is above the\nthreshold, the host is not ejected.\n3. The endpoint is ejected for some number of milliseconds. Ejection means that the endpoint is marked\nunhealthy and will not be used during load balancing. The number of milliseconds is equal to the\nbase_ejection_time value multiplied by the number of times the host has been ejected.\n4. An ejected endpoint will automatically be brought back into service after the ejection time\nhas been satisfied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.panic_threshold": {
"type": "integer",
"description": "Exclusive with [no_panic_threshold]\n\nConfigure a threshold (percentage of unhealthy endpoints) below which\nall endpoints will be considered for load balancing ignoring its health status.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 100,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.proxy_protocol_v1": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.proxy_protocol_v2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.automatic_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint_selection": {
"type": "string",
"description": "Policy for selection of endpoints from local site/remote site/both\n\nConsider both remote and local endpoints for load balancing\nLOCAL_ONLY: Consider only local endpoints for load balancing\nEnable this policy to load balance ONLY among locally discovered endpoints\nPrefer the local endpoints for load balancing. If local endpoints are not present\nremote endpoints will be considered.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISTRIBUTED"
},
"spec.health_check_port": {
"type": "integer",
"description": "Exclusive with [same_as_endpoint_port]\nPort used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "networking",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "networking",
"note": "Asymmetry: port enforces [1,65535], health_check_port allows 0",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.healthcheck": {
"type": "array",
"description": "Reference to healthcheck configuration objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.loadbalancer_algorithm": {
"type": "string",
"description": "Different load balancing algorithms supported\nWhen a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm\nto determine which host is selected.\n\n- ROUND_ROBIN: ROUND_ROBIN\n\nPolicy in which each healthy/available upstream endpoint is selected in round robin order.\n- LEAST_REQUEST: LEAST_REQUEST\n\nPolicy in which loadbalancer picks the upstream endpoint which has the fewest active requests\n- RING_HASH: RING_HASH\n\nPolicy implements consistent hashing to upstream endpoints using ring hash of endpoint names\nHash of the incoming request is calculated using request hash policy.\nThe ring/modulo hash load balancer implements consistent hashing to upstream hosts.\nThe algorithm is based on mapping all hosts onto a circle such that the addition or\nremoval of a host from the host set changes only affect 1/N requests. This technique\nis also commonly known as “ketama” hashing. A consistent hashing load balancer is only\neffective when protocol routing is used that specifies a value to hash on. The minimum\nring size governs the replication factor for each host in the ring. For example, if the\nminimum ring size is 1024 and there are 16 hosts, each host will be replicated 64 times.\n- RANDOM: RANDOM\n\nPolicy in which each available upstream endpoint is selected in random order.\nThe random load balancer selects a random healthy host. The random load balancer generally\nperforms better than round robin if no health checking policy is configured. Random selection\navoids bias towards the host in the set that comes after a failed host.\n- LB_OVERRIDE: Load Balancer Override\n\nHash policy is taken from from the load balancer which is using this origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ROUND_ROBIN"
},
"spec.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers": {
"type": "array",
"description": "List of origin servers in this pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Exclusive with [automatic_port lb_port]\nEndpoint service is available on this port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.same_as_endpoint_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type": {
"type": "object",
"description": "Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.disable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.enable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls": {
"type": "object",
"description": "Upstream TLS Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.default_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.disable_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.disable_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.max_session_keys": {
      "type": "integer",
"description": "Exclusive with [default_session_key_caching disable_session_key_caching]\n\nNumber of session keys that are cached.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2,
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.no_mtls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.skip_server_verification": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.sni": {
"type": "string",
"description": "Exclusive with [disable_sni use_host_header_as_sni]\nSNI value to be used.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"constraints": {
"constraintType": "object",
"category": "tls",
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "tls",
"note": "Required when use_tls is selected — API returns 400 if nil",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_host_header_as_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_mtls": {
"type": "object",
"description": "MTLS Client Certificate.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_mtls_obj": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_server_verification": {
"type": "object",
"description": "Upstream TLS Validation Context.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.volterra_trusted_ca": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.health_check_port_choice": [
"health_check_port",
"same_as_endpoint_port"
],
"spec.port_choice": [
"automatic_port",
"lb_port",
"port"
],
"spec.tls_choice": [
"no_tls",
"use_tls"
],
"spec.advanced_options.circuit_breaker_choice": [
"circuit_breaker",
"default_circuit_breaker",
"disable_circuit_breaker"
],
"spec.advanced_options.http_protocol_type": [
"auto_http_config",
"http1_config",
"http2_options"
],
"spec.advanced_options.lb_source_ip_persistence_choice": [
"disable_lb_source_ip_persistence",
"enable_lb_source_ip_persistence"
],
"spec.advanced_options.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.advanced_options.outlier_detection_choice": [
"disable_outlier_detection",
"outlier_detection"
],
"spec.advanced_options.panic_threshold_type": [
"no_panic_threshold",
"panic_threshold"
],
"spec.advanced_options.proxy_protocol_choice": [
"disable_proxy_protocol",
"proxy_protocol_v1",
"proxy_protocol_v2"
],
"spec.advanced_options.subset_choice": [
"disable_subsets",
"enable_subsets"
],
"spec.advanced_options.enable_subsets.fallback_policy_choice": [
"any_endpoint",
"default_subset",
"fail_request"
],
"spec.upstream_conn_pool_reuse_type.map_downstream_to_upstream_conn_pool_type": [
"disable_conn_pool_reuse",
"enable_conn_pool_reuse"
],
"spec.use_tls.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.use_tls.mtls_choice": [
"no_mtls",
"use_mtls",
"use_mtls_obj"
],
"spec.use_tls.server_validation_choice": [
"skip_server_verification",
"use_server_verification",
"volterra_trusted_ca"
],
"spec.use_tls.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.use_tls.tls_config.choice": [
"custom_security",
"default_security",
"low_security",
"medium_security"
],
"spec.use_tls.use_server_verification.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_origin_pool",
"description": "Replace Origin Pool.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/origin_pools/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a origin_pool",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.origin_pool.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsorigin_poolReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Backend origin servers or load balancing pool for distributing traffic",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.origin_servers",
"spec.port"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: origin_pool\nmetadata:\n  name: backend-pool\n  namespace: default\nspec:\n  origin_servers:\n    - public_name:\n        dns_name: backend1.example.com\n    - public_name:\n        dns_name: backend2.example.com\n  port: 8080\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"backend-pool\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"origin_servers\": [\n      {\"public_name\": {\"dns_name\": \"backend1.example.com\"}},\n      {\"public_name\": {\"dns_name\": \"backend2.example.com\"}}\n    ],\n    \"port\": 8080\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "backend-pool",
"namespace": "default"
},
"spec": {
"origin_servers": [
{
"public_name": {
"dns_name": "backend1.example.com"
}
},
{
"public_name": {
"dns_name": "backend2.example.com"
}
}
],
"port": 8080
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.origin_servers",
"spec.port"
],
"description": "Backend origin servers or load balancing pool for distributing traffic"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the origin pool create specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advanced_options": {
"type": "object",
"description": "Configure Advanced OPTIONS for origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.auto_http_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.circuit_breaker": {
"type": "object",
"description": "CircuitBreaker provides a mechanism for watching failures in upstream connections or requests\nand if the failures reach a certain threshold, automatically fail subsequent requests which\nallows to apply back pressure on downstream quickly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to endpoints in the cluster.\nThis is specified in milliseconds. The default value is 2 seconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.default_circuit_breaker": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_circuit_breaker": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_lb_source_ip_persistence": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "disable_lb_source_ip_persistance"
},
"spec.advanced_options.disable_outlier_detection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_proxy_protocol": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.disable_subsets": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.enable_lb_source_ip_persistence": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "enable_lb_source_ip_persistance"
},
"spec.advanced_options.enable_subsets": {
"type": "object",
"description": "Configure subset OPTIONS for origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.http1_config": {
"type": "object",
"description": "HTTP/1.1 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.http2_options": {
"type": "object",
"description": "Http2 Protocol OPTIONS for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.http_idle_timeout": {
"type": "integer",
"description": "The idle timeout for upstream connection pool connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 5 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\nSets the maximum number of requests allowed per connection to the origin server.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.no_panic_threshold": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.outlier_detection": {
"type": "object",
"description": "Outlier detection and ejection is the process of dynamically determining whether some number\nof hosts in an upstream cluster are performing unlike the others and removing them from the\nhealthy load balancing set. Outlier detection is a form of passive health checking.\n\nAlgorithm\n\n1. A endpoint is determined to be an outlier (based on configured number of consecutive_5xx\nor consecutive_gateway_failures) .\n2. If no endpoints have been ejected, loadbalancer will eject the host immediately.\nOtherwise, it checks to make sure the number of ejected hosts is below the allowed threshold\n(specified via max_ejection_percent setting). If the number of ejected hosts is above the\nthreshold, the host is not ejected.\n3. The endpoint is ejected for some number of milliseconds. Ejection means that the endpoint is marked\nunhealthy and will not be used during load balancing. The number of milliseconds is equal to the\nbase_ejection_time value multiplied by the number of times the host has been ejected.\n4. An ejected endpoint will automatically be brought back into service after the ejection time\nhas been satisfied.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.panic_threshold": {
"type": "integer",
"description": "Exclusive with [no_panic_threshold]\n\nConfigure a threshold (percentage of unhealthy endpoints) below which\nall endpoints will be considered for load balancing ignoring its health status.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 100,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.proxy_protocol_v1": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advanced_options.proxy_protocol_v2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.automatic_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.endpoint_selection": {
"type": "string",
"description": "Policy for selection of endpoints from local site/remote site/both\n\nConsider both remote and local endpoints for load balancing\nLOCAL_ONLY: Consider only local endpoints for load balancing\nEnable this policy to load balance ONLY among locally discovered endpoints\nPrefer the local endpoints for load balancing. If local endpoints are not present\nremote endpoints will be considered.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DISTRIBUTED"
},
"spec.health_check_port": {
"type": "integer",
"description": "Exclusive with [same_as_endpoint_port]\nPort used for performing health check.",
"constraints": {
"constraintType": "number",
"category": "networking",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "networking",
"note": "Asymmetry: port enforces [1,65535], health_check_port allows 0",
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.healthcheck": {
"type": "array",
"description": "Reference to healthcheck configuration objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.lb_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.loadbalancer_algorithm": {
"type": "string",
"description": "Different load balancing algorithms supported\nWhen a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm\nto determine which host is selected.\n\n- ROUND_ROBIN: ROUND_ROBIN\n\nPolicy in which each healthy/available upstream endpoint is selected in round robin order.\n- LEAST_REQUEST: LEAST_REQUEST\n\nPolicy in which loadbalancer picks the upstream endpoint which has the fewest active requests\n- RING_HASH: RING_HASH\n\nPolicy implements consistent hashing to upstream endpoints using ring hash of endpoint names\nHash of the incoming request is calculated using request hash policy.\nThe ring/modulo hash load balancer implements consistent hashing to upstream hosts.\nThe algorithm is based on mapping all hosts onto a circle such that the addition or\nremoval of a host from the host set changes only affect 1/N requests. This technique\nis also commonly known as “ketama” hashing. A consistent hashing load balancer is only\neffective when protocol routing is used that specifies a value to hash on. The minimum\nring size governs the replication factor for each host in the ring. For example, if the\nminimum ring size is 1024 and there are 16 hosts, each host will be replicated 64 times.\n- RANDOM: RANDOM\n\nPolicy in which each available upstream endpoint is selected in random order.\nThe random load balancer selects a random healthy host. The random load balancer generally\nperforms better than round robin if no health checking policy is configured. Random selection\navoids bias towards the host in the set that comes after a failed host.\n- LB_OVERRIDE: Load Balancer Override\n\nHash policy is taken from from the load balancer which is using this origin pool.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ROUND_ROBIN"
},
"spec.no_tls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_servers": {
"type": "array",
"description": "List of origin servers in this pool.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.port": {
"type": "integer",
"description": "Exclusive with [automatic_port lb_port]\nEndpoint service is available on this port.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.same_as_endpoint_port": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type": {
"type": "object",
"description": "Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.disable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upstream_conn_pool_reuse_type.enable_conn_pool_reuse": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls": {
"type": "object",
"description": "Upstream TLS Parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.default_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.disable_session_key_caching": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.disable_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.max_session_keys": {
      "type": "integer",
"description": "Exclusive with [default_session_key_caching disable_session_key_caching]\n\nNumber of session keys that are cached.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2,
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.no_mtls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.skip_server_verification": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.sni": {
"type": "string",
"description": "Exclusive with [disable_sni use_host_header_as_sni]\nSNI value to be used.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"constraints": {
"constraintType": "object",
"category": "tls",
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"category": "tls",
"note": "Required when use_tls is selected — API returns 400 if nil",
      "validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_host_header_as_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_mtls": {
"type": "object",
"description": "MTLS Client Certificate.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_mtls_obj": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.use_server_verification": {
"type": "object",
"description": "Upstream TLS Validation Context.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.use_tls.volterra_trusted_ca": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.health_check_port_choice": [
"health_check_port",
"same_as_endpoint_port"
],
"spec.port_choice": [
"automatic_port",
"lb_port",
"port"
],
"spec.tls_choice": [
"no_tls",
"use_tls"
],
"spec.advanced_options.circuit_breaker_choice": [
"circuit_breaker",
"default_circuit_breaker",
"disable_circuit_breaker"
],
"spec.advanced_options.http_protocol_type": [
"auto_http_config",
"http1_config",
"http2_options"
],
"spec.advanced_options.lb_source_ip_persistence_choice": [
"disable_lb_source_ip_persistence",
"enable_lb_source_ip_persistence"
],
"spec.advanced_options.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.advanced_options.outlier_detection_choice": [
"disable_outlier_detection",
"outlier_detection"
],
"spec.advanced_options.panic_threshold_type": [
"no_panic_threshold",
"panic_threshold"
],
"spec.advanced_options.proxy_protocol_choice": [
"disable_proxy_protocol",
"proxy_protocol_v1",
"proxy_protocol_v2"
],
"spec.advanced_options.subset_choice": [
"disable_subsets",
"enable_subsets"
],
"spec.advanced_options.enable_subsets.fallback_policy_choice": [
"any_endpoint",
"default_subset",
"fail_request"
],
"spec.upstream_conn_pool_reuse_type.map_downstream_to_upstream_conn_pool_type": [
"disable_conn_pool_reuse",
"enable_conn_pool_reuse"
],
"spec.use_tls.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.use_tls.mtls_choice": [
"no_mtls",
"use_mtls",
"use_mtls_obj"
],
"spec.use_tls.server_validation_choice": [
"skip_server_verification",
"use_server_verification",
"volterra_trusted_ca"
],
"spec.use_tls.sni_choice": [
"disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.use_tls.tls_config.choice": [
"custom_security",
"default_security",
"low_security",
"medium_security"
],
"spec.use_tls.use_server_verification.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
]
}
},
{
"name": "list_origin_pools",
"description": "List Origin Pool.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/origin_pools",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_origin_pool",
"description": "DELETE Origin Pool.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/origin_pools/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a origin_pool",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.origin_pool.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for origin_poolDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for origin_poolDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
}
},
{
"name": "get_origin_pool",
"description": "GET Origin Pool.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/origin_pools/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"override-pop": {
"name": "override-pop",
"displayName": "Override Pop",
"operations": [
{
"name": "create_override_pop",
"description": "Remove Override.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/pop",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Shape of remove to remove override for API endpoints.",
      "title": "Remove API endpoint override request",
      "x-displayname": "Remove Override Request.",
"x-ves-proto-message": "ves.io.schema.app_type.OverridePopReq",
"properties": {
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"title": "App Type",
"x-displayname": "App Type",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Shape of remove to remove override for API endpoints.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_typeOverridePopReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeOverridePopReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"status_msg": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeOverridePopReq"
},
"fieldMetadata": {
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "boolean",
"description": "Status of the add operation (success or fail)"
},
{
"field": "status_msg",
"type": "string",
"description": "Message string for the status of add operation."
}
]
}
]
},
	"override-push": {
"name": "override-push",
"displayName": "Override Push",
"operations": [
{
"name": "create_override_push",
"description": "Add Override.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/push",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Shape of request to add override for API endpoints.",
      "title": "Add API endpoint override request",
      "x-displayname": "Add Override Request.",
"x-ves-proto-message": "ves.io.schema.app_type.OverridePushReq",
"properties": {
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"title": "App Type",
"x-displayname": "App Type",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"override_info": {
"allOf": [
{
"$ref": "#/components/schemas/app_typeOverrideInfo"
}
],
"x-f5xc-description-short": "Configuration parameter for override info.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Shape of request to add override for API endpoints.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_typeOverridePushReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeOverridePushReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"status_msg": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeOverridePushReq"
},
"fieldMetadata": {
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"override_info": {
"type": "object",
"description": "Rule to override a given automatic dynamic identifier used to expand or collapse API URL.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"override_info.component_identifier": {
"type": "string",
"description": "Configuration parameter for component identifier",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"override_info.set_dynamic": {
"type": "boolean",
"description": "Enable or Disable component to be considered as dynamic to collapse or expand API URL.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "boolean",
"description": "Status of the add operation (success or fail)"
},
{
"field": "status_msg",
"type": "string",
"description": "Message string for the status of add operation."
}
]
}
]
},
	"overrides": {
"name": "overrides",
"displayName": "Overrides",
"operations": [
{
"name": "list_overrides",
"description": "GET Override.",
"method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/overrides",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"override_list": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "override_list",
"type": "array",
"description": "List of all override applied to API endpoints of requested App Type."
      }
]
}
]
},
	"partner-management-child-tenant-managers-child-tenants": {
"name": "partner-management-child-tenant-managers-child-tenants",
"displayName": "Partner Management Child Tenant Managers Child Tenants",
"operations": [
{
"name": "list_partner_management_child_tenant_managers_child_tenants",
"description": "List child tenants for a given child tenant manager.",
"method": "GET",
"path": "/api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "List of Child Tenants referring to input CTM."
}
]
}
]
},
	"partner-management-child-tenant-managers-child-tenants-migrate": {
"name": "partner-management-child-tenant-managers-child-tenants-migrate",
"displayName": "Partner Management Child Tenant Managers Child Tenants Migrate",
"operations": [
{
"name": "create_partner_management_child_tenant_managers_child_tenants_migrate",
"description": "Migrate CTM child tenants.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants/migrate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to migrate child tenants to a specified child tenant manager.",
"title": "MigrateCTMChildTenantsReq",
"x-displayname": "Migrate CTM child tenants request.",
"x-ves-oneof-field-migratectmchildtenantsreqchoice": "[\"ct_list_to_target_ctm\"]",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant_manager.MigrateCTMChildTenantsReq",
"properties": {
"ct_list_to_target_ctm": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_managementCTListToCTM"
}
],
"x-f5xc-description-short": "Configuration parameter for ct list to target ctm.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the child tenant manager.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to migrate child tenants to a specified child tenant manager.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for child_tenant_managerMigrateCTMChildTenantsReq",
"required_fields": [
"name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for child_tenant_managerMigrateCTMChildTenantsReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"child_tenant_manager": {
"type": "string"
},
"errors": {
"type": "array"
},
"migrate_initiated_for_ct_count": {
"type": "integer"
},
"total_ct_count": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value"
}
},
"requiredFields": [
"name"
],
"description": "Minimum configuration for child_tenant_managerMigrateCTMChildTenantsReq"
},
"fieldMetadata": {
"ct_list_to_target_ctm": {
"type": "object",
"description": "Child tenants reference to child tenant manager.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ct_list_to_target_ctm.child_tenant_manager": {
"type": "string",
"description": "Name of the child tenant manager where child tenants needs to be referred.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ct_list_to_target_ctm.child_tenants": {
"type": "array",
"description": "List of child tenants refer to a child tenant manager.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the child tenant manager.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"migratectmchildtenantsreqchoice": [
"ct_list_to_target_ctm"
]
},
"responseSummary": [
{
"field": "child_tenant_manager",
"type": "string",
"description": "Name of the child tenant manager to which all the child tenants are migrating to."
},
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while migrating child tenants."
},
{
"field": "migrate_initiated_for_ct_count",
"type": "integer",
"description": "This specifies the total number of child tenants for which migration has been initiated to a specified CTM."
},
{
"field": "total_ct_count",
"type": "integer",
"description": "This specifies total number of child tenants requested to be migrated to a specified CTM."
}
]
}
]
},
	"partner-management-child-tenants": {
"name": "partner-management-child-tenants",
"displayName": "Partner Management Child Tenants",
"operations": [
{
"name": "list_partner_management_child_tenants",
"description": "List of Child Tenants.",
"method": "GET",
"path": "/api/web/namespaces/system/partner-management/child_tenants",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "ctm",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page_start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page_limit",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"access_config": {
      "type": "array"
},
"next_page": {
"type": "string"
},
"total_count": {
"type": "integer"
},
"total_filtered_count": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "access_config",
      "type": "array",
"description": "Allowed access configuration details for the tenant."
      },
{
"field": "next_page",
"type": "string",
"description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page."
},
{
"field": "total_count",
"type": "integer",
"description": "TotalCount holds total count of access config."
      },
{
"field": "total_filtered_count",
"type": "integer",
"description": "TotalFilteredCount holds total count of access config after filtering."
      }
]
}
]
},
	"partner-management-child-tenants-migrate": {
"name": "partner-management-child-tenants-migrate",
"displayName": "Partner Management Child Tenants Migrate",
"operations": [
{
"name": "create_partner_management_child_tenants_migrate",
"description": "Migrate Child Tenants.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/child_tenants/migrate",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to migrate child tenants to a specified new child tenant manager.",
"title": "MigrateChildTenantsReq",
"x-displayname": "Migrate child tenants request.",
"x-ves-oneof-field-migratechildtenantsreqchoice": "[\"ct_list_to_target_ctm\"]",
"x-ves-proto-message": "ves.io.schema.tenant_management.child_tenant.MigrateChildTenantsReq",
"properties": {
"ct_list_to_target_ctm": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_managementCTListToCTM"
}
],
"x-f5xc-description-short": "Configuration parameter for ct list to target ctm.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to migrate child tenants to a specified new child tenant manager.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for child_tenantMigrateChildTenantsReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for child_tenantMigrateChildTenantsReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"child_tenant_manager": {
"type": "string"
},
"errors": {
"type": "array"
},
"migrate_initiated_for_ct_count": {
"type": "integer"
},
"total_ct_count": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for child_tenantMigrateChildTenantsReq"
},
"fieldMetadata": {
"ct_list_to_target_ctm": {
"type": "object",
"description": "Child tenants reference to child tenant manager.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ct_list_to_target_ctm.child_tenant_manager": {
"type": "string",
"description": "Name of the child tenant manager where child tenants needs to be referred.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ct_list_to_target_ctm.child_tenants": {
"type": "array",
"description": "List of child tenants refer to a child tenant manager.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"migratechildtenantsreqchoice": [
"ct_list_to_target_ctm"
]
},
"responseSummary": [
{
"field": "child_tenant_manager",
"type": "string",
"description": "Name of the child tenant manager to which all the child tenants are migrating to."
},
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while migrating child tenants."
},
{
"field": "migrate_initiated_for_ct_count",
"type": "integer",
"description": "This specifies the total number of child tenants for which migration has been initiated to a specified CTM."
},
{
"field": "total_ct_count",
"type": "integer",
"description": "This specifies total number of child tenants requested to be migrated to a specified CTM."
}
]
}
]
},
	"partner-management-customer-supports": {
"name": "partner-management-customer-supports",
"displayName": "Partner Management Customer Supports",
"operations": [
{
"name": "list_partner_management_customer_supports",
"description": "List all support tickets created in child tenant.",
"method": "GET",
"path": "/api/web/namespaces/system/partner-management/customer_supports",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "create_partner_management_customer_support",
"description": "Create customer support ticket in child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/customer_supports",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of customer_support",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.customer_support.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/schemacustomer_supportCreateSpecType__ves_io_schema_tenant_management_child_tenant"
}
],
"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 schemacustomer_supportCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schemacustomer_supportCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schemacustomer_supportCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new customer support ticket in our customer support provider system.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.category": {
"type": "string",
"description": "Ticket area further narrows down the ticket - infrastructure, application,\ndashboards can be examples.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.comments": {
"type": "array",
"description": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.description": {
"type": "string",
"description": "Customer's description of the issue (free text)",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ongoing": {
"type": "boolean",
"description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.priority": {
"type": "string",
"description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRIORITY_UNKNOWN"
},
"spec.product_data": {
"type": "string",
"description": "Product data is a free text field that can be used to describe the issue in more detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.relates_to": {
"type": "array",
"description": "Optional reference to any original ticket in case the ticket being created is a followup.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service": {
"type": "string",
"description": "Indicates the list of support service\n\nUnknown Support Service\nAccount Protection Support Service\nAdministration Support Service\nApplication Traffic Insight Support Service\nAudit Logs & Alerts Support Service\nAuthentication Intelligence Support Service\nBilling Support Service\nClient Side Defense Support Service\nCloud & Edge Sites Support Service\ndeprecated: use SS_MULTI_CLOUD_NETWORK_CONNECT instead\nDDoS & Transit Support Service\nDeprecated: use SS_ROUTED_DDOS instead\nDistributed Apps Support Service\nDNS Management Support Service\nLoadBalancers Support Service\ndeprecated: use SS_MULTI_CLOUD_APP_CONNECT instead\nShared Configuration Support Service\nWeb App & API Protection Support Service\nOther Support Service\nBot Defense Support Service\nContent delivery network Support Service\nObservability Support Service\nDelegated Access Support Service\nNetworking & security across clouds, edge and on-premises\nConnect apps across clouds, edge and on-premises using Load Balancers\nData Intelligence Support Service\nNGINX One Support Service\nWeb App Scanning Support Service\nRouted DDoS Support Service\nMobile App Shield protects mobile apps from reverse engineering, tampering and malware\nDefault for deprecated services\nAutomation Support Service for Terraform Provider.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SS_UNKNOWN"
},
"spec.status": {
"type": "string",
"description": "State of the ticket so the customers know if the problem is being looked into\n\nUnknown or empty support ticket status\nIndicates a new ticket, waiting to be assigned to an agent\nIndicates an open issues, actively being looked into\nIndicates a pending issue, an open issue not actively being looked into\nIndicates on issue that on-hold, waiting for more information\nIndicates a solved issue, waiting for customer's confirmation\nIndicates a closed issue, resolved and customer approved\nIndicates a failed ticket, a failed ticket didn't make it into Salesforce and a customer should create new one instead.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "STATUS_UNKNOWN"
},
"spec.subject": {
"type": "string",
"description": "Subject of the ticket.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timeline": {
"type": "string",
"description": "Timeline is a free text field that can be used to describe the issue in more detail.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.timezone": {
"type": "string",
"description": "Stores the timezone provided by the user at the time of support ticket creation.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Z][a-zA-Z_]+/[A-Z][a-zA-Z_]+$",
"formatDescription": "IANA timezone database (e.g., America/New_York)",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.topic": {
"type": "string",
"description": "Support Topic indicates the list of topics for service tickets\n\nUnknown/empty priority\nACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST\nACCOUNT_SUPPORT_TOPIC_ACCOUNT\nACCOUNT_SUPPORT_TOPIC_BILLING\nACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE\nACCOUNT_SUPPORT_TOPIC_PUBLIC_IP\nACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE\nACCOUNT_SUPPORT_TOPIC_RMA\nACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION\nACCOUNT_SUPPORT_TOPIC_OTHERS\nTECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES\nTECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE\nTECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION\nTECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION\nTECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING\nTECHNICAL_SUPPORT_TOPIC_OTHERS\nINCIDENT_SUPPORT_TOPIC_LATENCY\nINCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION\nINCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE\nINCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE\nINCIDENT_SUPPORT_TOPIC_OTHERS\nTASK_TOPIC_PLAN_TRANSITION\nPROBLEM_TOPIC_SUPPORT_ALERT\nQUESTION_TOPIC_INFRASTRUCTURE\nTECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION\nTECHNICAL_SUPPORT_TOPIC_TERRAFORM_PROVIDER.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TOPIC_UNKNOWN"
},
"spec.tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.type": {
"type": "string",
"description": "Several types of issues are supported, such as problems, questions.\n\nUnknown or empty ticket type\nIndicates a problem (e.g. Misconfiguration)\nIndicates a task (a request to do something)\nIndicates a question (billing, services related)\nIndicates an incident (something is not working)\nIndicates a technical support ticket\nIndicates an account support ticket\nIndicates an Incident support ticket.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TYPE_UNKNOWN"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "get_partner_management_customer_support",
"description": "GET customer support ticket in child tenant.",
"method": "GET",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"partner-management-customer-supports-close": {
"name": "partner-management-customer-supports-close",
"displayName": "Partner Management Customer Supports Close",
"operations": [
{
"name": "create_partner_management_customer_supports_close",
"description": "Close a customer support ticket in child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/close",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Input request to fetch customer_support ticket in child / managed tenant.",
"title": "SupportTicketRequest",
"x-displayname": "Support Ticket Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest",
"properties": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSupportTicketRequest"
},
"fieldMetadata": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"partner-management-customer-supports-comment": {
"name": "partner-management-customer-supports-comment",
"displayName": "Partner Management Customer Supports Comment",
"operations": [
{
"name": "create_partner_management_customer_supports_comment",
"description": "Add comment to a customer support ticket in child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Adds a new comment to an existing customer support ticket.",
"title": "CommentRequest",
"x-displayname": "Customer support ticket comment request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.CommentRequest",
"properties": {
"attachments": {
"type": "array",
"description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"title": "Binary attachments",
"items": {
"$ref": "#/components/schemas/customer_supportAttachmentType"
},
"x-displayname": "Attachments.",
"x-f5xc-description-short": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"comment": {
"type": "string",
"description": "Comment on a existing customer support ticket.",
"title": "comment",
"x-displayname": "Comment",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Comment on a existing customer support ticket.",
"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-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Adds a new comment to an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schematenant_managementCommentRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schematenant_managementCommentRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schematenant_managementCommentRequest"
},
"fieldMetadata": {
"attachments": {
"type": "array",
"description": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"comment": {
"type": "string",
"description": "Comment on a existing customer support ticket.",
"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-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"partner-management-customer-supports-comment-attachment": {
"name": "partner-management-customer-supports-comment-attachment",
"displayName": "Partner Management Customer Supports Comment Attachment",
"operations": [
{
"name": "get_partner_management_customer_supports_comment_attachment",
"description": "GET attachment.",
"method": "GET",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment/{comment_id}/attachment/{attachment_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "comment_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "attachment_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"partner-management-customer-supports-escalate": {
"name": "partner-management-customer-supports-escalate",
"displayName": "Partner Management Customer Supports Escalate",
"operations": [
{
"name": "create_partner_management_customer_supports_escalate",
"description": "Escalate a ticket in child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/escalate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Input request to fetch customer_support ticket in child / managed tenant.",
"title": "SupportTicketRequest",
"x-displayname": "Support Ticket Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest",
"properties": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSupportTicketRequest"
},
"fieldMetadata": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"partner-management-customer-supports-priority": {
"name": "partner-management-customer-supports-priority",
"displayName": "Partner Management Customer Supports Priority",
"operations": [
{
"name": "create_partner_management_customer_supports_priority",
"description": "Change priority of a ticket in child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/priority",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Priority of an existing customer support ticket.",
"title": "PriorityRequest",
"x-displayname": "Customer support ticket priority request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.PriorityRequest",
"properties": {
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/customer_supportSupportTicketPriority"
}
],
"x-f5xc-example": "10",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Priority of an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schematenant_managementPriorityRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schematenant_managementPriorityRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schematenant_managementPriorityRequest"
},
"fieldMetadata": {
"priority": {
"type": "string",
"description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRIORITY_UNKNOWN"
},
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"partner-management-customer-supports-reopen": {
"name": "partner-management-customer-supports-reopen",
"displayName": "Partner Management Customer Supports Reopen",
"operations": [
{
"name": "create_partner_management_customer_supports_reopen",
"description": "Reopen a closed customer support ticket in child tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/reopen",
      "dangerLevel": "medium",
"parameters": [
{
"name": "tp_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Input request to fetch customer_support ticket in child / managed tenant.",
"title": "SupportTicketRequest",
"x-displayname": "Support Ticket Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SupportTicketRequest",
"properties": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"title": "Third party ID",
"x-displayname": "Third Party ID.",
"x-ves-example": "123",
"x-f5xc-example": "123",
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Input request to fetch customer_support ticket in child / managed tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSupportTicketRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSupportTicketRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSupportTicketRequest"
},
"fieldMetadata": {
"tp_id": {
"type": "string",
"description": "ID assigned to this ticket by our support provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"payment-method-primary": {
"name": "payment-method-primary",
"displayName": "Payment Method Primary",
"operations": [
{
"name": "create_payment_method_primary",
"description": "Make credit card primary.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/billing/payment_method/{name}/primary",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Changes a payment method role to primary.",
"title": "Change payment method role request",
"x-displayname": "Payment method primary.",
"x-ves-proto-message": "ves.io.schema.billing.payment_method.PaymentMethodPrimaryReq",
"properties": {
"name": {
"type": "string",
"description": "The name of the payment method object to be made primary.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Payment-method-1.",
"x-f5xc-example": "payment-method-1",
"x-f5xc-description-short": "The name of the payment method object to be made primary.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the payment method object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the payment method object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Changes a payment method role to primary.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for payment_methodPaymentMethodPrimaryReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for payment_methodPaymentMethodPrimaryReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for payment_methodPaymentMethodPrimaryReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the payment method object to be made primary.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the payment method object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"payment-method-secondary": {
"name": "payment-method-secondary",
"displayName": "Payment Method Secondary",
"operations": [
{
"name": "create_payment_method_secondary",
"description": "Make payment method secondary.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/billing/payment_method/{name}/secondary",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Changes a payment method role to secondary.",
"title": "Change payment method role request",
"x-displayname": "Payment method secondary.",
"x-ves-proto-message": "ves.io.schema.billing.payment_method.PaymentMethodSecondaryReq",
"properties": {
"name": {
"type": "string",
"description": "The name of the payment method object to be made secondary.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Payment-method-1.",
"x-f5xc-example": "payment-method-1",
"x-f5xc-description-short": "The name of the payment method object to be made secondary.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the payment method object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the payment method object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Changes a payment method role to secondary.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for payment_methodPaymentMethodSecondaryReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for payment_methodPaymentMethodSecondaryReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for payment_methodPaymentMethodSecondaryReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the payment method object to be made secondary.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the payment method object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"payment-method-swap-primary": {
"name": "payment-method-swap-primary",
"displayName": "Payment Method Swap Primary",
"operations": [
{
"name": "create_payment_method_swap_primary",
"description": "Make payment method secondary.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/billing/payment_method/{name}/swap-primary",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Changes a payment method role (from/to primary or backup)",
"title": "Change payment method role request",
"x-displayname": "Payment method role swap.",
"x-ves-proto-message": "ves.io.schema.billing.payment_method.PaymentMethodRoleSwapReq",
"properties": {
"name": {
"type": "string",
"description": "The name of the payment method object to be updated.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Payment-method-1.",
"x-f5xc-example": "payment-method-1",
"x-f5xc-description-short": "The name of the payment method object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the payment method object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the payment method object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Changes a payment method role (from/to primary or backup).",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for payment_methodPaymentMethodRoleSwapReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for payment_methodPaymentMethodRoleSwapReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for payment_methodPaymentMethodRoleSwapReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the payment method object to be updated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the payment method object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"payment-methods": {
"name": "payment-methods",
"displayName": "Payment Methods",
"operations": [
{
"name": "create_payment_method",
"description": "Create payment method specification.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/billing/payment_methods",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of payment_method",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.billing.payment_method.CreatePaymentMethodRequest",
"properties": {
"contact": {
"allOf": [
{
"$ref": "#/components/schemas/contactGlobalSpecType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This namespace specifies the namespace in which the payment method will be created.\nIf not provided, the default 'system' namespace will be used.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "Namespace specifies the namespace in which the payment method will be created. If not provided, the default 'system' namespace will be used.",
"x-f5xc-description-medium": "Namespace specifies the namespace in which the payment method will be created. If not provided, the default 'system' namespace will be used.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"role": {
"allOf": [
{
"$ref": "#/components/schemas/payment_methodPaymentMethodRole"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"token": {
      "type": "string",
"description": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g. Stripe.",
      "title": "Token",
      "x-displayname": "Token",
      "x-ves-example": "Tok-123456.",
"x-f5xc-example": "tok-123456",
"x-f5xc-description-short": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g.",
      "x-f5xc-description-medium": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g. Stripe.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for payment_methodCreatePaymentMethodRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for payment_methodCreatePaymentMethodRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for payment_methodCreatePaymentMethodRequest"
},
"fieldMetadata": {
"contact": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"contact.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"contact.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "This namespace specifies the namespace in which the payment method will be created.\nIf not provided, the default 'system' namespace will be used.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"role": {
"type": "string",
"description": "Defines if a payment method is used as a primary or backup source of fund.\n\nUnknown payment method role\nPrimary payment method role. Always used when attempting to charge for F5 Distributed Cloud's services.\nSecondary payment method role. Used when primary payment method failed.\nNormal payment method is a card that has no role as such.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PAYMENT_METHOD_ROLE_UNKNOWN"
},
"token": {
      "type": "string",
"description": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g. Stripe.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "name",
"type": "string",
"description": "Name of the newly created payment method object."
}
]
},
{
"name": "delete_payment_method",
"description": "DELETE the specified payment method.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/billing/payment_methods/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
]
}
]
},
	"plan-transition": {
"name": "plan-transition",
"displayName": "Plan Transition",
"operations": [
{
"name": "create_plan_transition",
"description": "InitiatePlanTransition.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/billing/plan_transition",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request body of InitiatePlanTransition custom API.",
      "title": "InitiatePlanTransitionReq",
"x-displayname": "InitiatePlanTransitionReq.",
"x-ves-proto-message": "ves.io.schema.billing.plan_transition.InitiatePlanTransitionReq",
"properties": {
"namespace": {
"type": "string",
"description": "This namespace is not used, all requests are stored under system namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "Namespace is not used, all requests are stored under system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"new_plan": {
"type": "string",
"description": "New plan template name tenant want to move to.",
"title": "New plan",
"x-displayname": "New Plan",
"x-ves-example": "Plan-1",
"x-f5xc-example": "plan-1",
"x-f5xc-description-short": "New plan template name tenant want to move to.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload": {
"allOf": [
{
"$ref": "#/components/schemas/plan_transitionTransitionPayload"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request body of InitiatePlanTransition custom API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for plan_transitionInitiatePlanTransitionReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for plan_transitionInitiatePlanTransitionReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"requires_manual_approval": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for plan_transitionInitiatePlanTransitionReq"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "This namespace is not used, all requests are stored under system namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"new_plan": {
"type": "string",
"description": "New plan template name tenant want to move to.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload": {
"type": "object",
"description": "Payload which is required to execute transition from the current tenant's plan to a given new_plan.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"payload.billing_address.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_address.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.billing_provider_account_id": {
"type": "string",
"description": "ID of the billing provider account created to verify the billing info provided with this object.\nThe ID is then used to ensure no more duplicate billing account is created.\nNote: this is set by the backend during the creation of plan_transition object. Anything passed from UI will be ignored.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.create_support_ticket": {
"type": "boolean",
"description": "If set to true, a support ticket will be created to provide the plan transition request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.deletion_feedback": {
"type": "string",
"description": "Feedback from the customer related to reason of account deletion.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.deletion_reason": {
"type": "string",
"description": "List of available reason for account deletion.\n\n- REASON_UNKNOWN: Unknown reason\n\nUnknown reason\n- REASON_SWITCH_TO_FREE_PLAN: Switch to free plan\n\nSwitch to free plan\n- REASON_NO_LONGER_NEEDED: No longer needed\n\nNo longer needed\n- REASON_NOT_JUSTIFY_COSTS: Too expensive\n\nToo expensive\n- REASON_DIFFICULT_TO_USE: Difficult to use\n\nDifficult to use.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "REASON_UNKNOWN"
},
"payload.domain": {
"type": "string",
"description": "Domain for enterprise tenants.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address": {
"type": "object",
"description": "Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.address1": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.address2": {
"type": "string",
"description": "Network address or location",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.city": {
"type": "string",
"description": "Configuration parameter for city",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.contact_type": {
"type": "string",
"description": "Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MAILING"
},
"payload.payment_address.country": {
"type": "string",
"description": "Configuration parameter for country",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.county": {
"type": "string",
"description": "Configuration parameter for county",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.phone_number": {
"type": "string",
"description": "Configuration parameter for phone number",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.state_code": {
"type": "string",
"description": "Configuration parameter for state code",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_address.zip_code": {
"type": "string",
"description": "IP address configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.payment_provider_token": {
      "type": "string",
"description": "Payment provider token (for credit card details)",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.subscribe_addon_services": {
"type": "array",
"description": "List of addon services that needs to be subscribed/enabled part of this plan transition.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.support_ticket_info": {
"type": "string",
"description": "Additional information user want to record part of the support ticket.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.tp_subscription_id": {
"type": "string",
"description": "ID of the third party subscription ID created.\nNote: this is set by the backend as part of the notifiers run as the plan_transition object is created.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"payload.unsubscribe_addon_services": {
"type": "array",
"description": "List of addon services that needs to be unsubscribed/removed part of this plan transition.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "id",
"type": "string",
"description": "ID of the newly created plan transition request."
},
{
"field": "requires_manual_approval",
"type": "boolean",
"description": "Flag to specify whether the request requires manual approval."
}
]
}
]
},
	"plans": {
"name": "plans",
"displayName": "Plans",
"operations": [
{
"name": "list_plans",
"description": "List Plan",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/plans",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_plan",
"description": "GET Plan",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/plans/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"platform-events": {
"name": "platform-events",
"displayName": "Platform Events",
"operations": [
{
"name": "create_platform_event",
"description": "Platform event Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/platform_events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch platform events.",
"title": "PlatformEventRequest",
"x-displayname": "Platform event Request.",
"x-ves-proto-message": "ves.io.schema.log.PlatformEventRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"include_config_changes": {
"type": "boolean",
"description": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in\nresponse. It is introduced to reduce any performance impact UI may face while rendering.\nOptional: default is false.",
"title": "include_config_changes",
"format": "boolean",
"x-displayname": "Exclude config changes.",
"x-f5xc-description-short": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in response.",
"x-f5xc-description-medium": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in response. It is introduced to reduce any performance impact UI may face while rendering.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch audit logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in platform events may be specified in the query.\nUser - user name\nresource_type - resource type\nresource - resource\nevent_type - event type\n\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then platform events matching ALL the matchers will be returned in the response.\nExample: query={resource_type=\"CUSTOMER_EDGE\"} will return all platform events with resource_type equals CUSTOMER_EDGE\n\nOptional: If not specified, all the platform events matching the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "{user=\\\"abc\\\", rsp_code=\\\"404\\\"}",
"x-f5xc-example": "\"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in platform events may be specified in the query. User - user name resource_type - resource type resource ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logPlatformEventRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logPlatformEventRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logPlatformEventRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"include_config_changes": {
"type": "boolean",
"description": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in\nresponse. It is introduced to reduce any performance impact UI may face while rendering.\nOptional: default is false.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch audit logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in platform events may be specified in the query.\nUser - user name\nresource_type - resource type\nresource - resource\nevent_type - event type\n\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then platform events matching ALL the matchers will be returned in the response.\nExample: query={resource_type=\"CUSTOMER_EDGE\"} will return all platform events with resource_type equals CUSTOMER_EDGE\n\nOptional: If not specified, all the platform events matching the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"policers": {
"name": "policers",
"displayName": "Policers",
"operations": [
{
"name": "create_policer",
"description": "Create Policer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/policers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of policer",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.policer.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/policerCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Rate limiter policy for controlling request rates to protected endpoints",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-rl\n  namespace: default\nspec:\n  burst_size: 1\n  committed_information_rate: 1\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-rl\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"burst_size\": 1,\n    \"committed_information_rate\": 1\n  }\n}\n"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-rl",
"namespace": "default"
},
"spec": {
"burst_size": 1,
"committed_information_rate": 1
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"description": "Rate limiter policy for controlling request rates to protected endpoints"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a new policer with traffic rate limits.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.burst_size": {
"type": "integer",
"description": "The maximum size permitted for bursts of data.\nE.g. 10000 pps burst.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.committed_information_rate": {
"type": "integer",
"description": "The committed information rate is the guaranteed packets rate for\ntraffic arriving or departing under normal conditions.\nE.g. 10000 pps.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 10000000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policer_mode": {
"type": "string",
"description": "- POLICER_MODE_NOT_SHARED: Not Shared\n\nA separate policer instance is created for each reference to the policer\n- POLICER_MODE_SHARED: Shared\n\nA common policer instance is used for for all references to the policer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "POLICER_MODE_NOT_SHARED"
},
"spec.policer_type": {
"type": "string",
"description": "Specifies the type of Policer\n\nBasic Single-Rate Two-Color Policer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "POLICER_SINGLE_RATE_TWO_COLOR"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_policer",
"description": "Replace Policer.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/policers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a policer",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.policer.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/policerReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Rate limiter policy for controlling request rates to protected endpoints",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-rl\n  namespace: default\nspec:\n  burst_size: 1\n  committed_information_rate: 1\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-rl\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"burst_size\": 1,\n    \"committed_information_rate\": 1\n  }\n}\n"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-rl",
"namespace": "default"
},
"spec": {
"burst_size": 1,
"committed_information_rate": 1
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"description": "Rate limiter policy for controlling request rates to protected endpoints"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a given policer with changed traffic rate limits.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.burst_size": {
"type": "integer",
"description": "The maximum size permitted for bursts of data.\nE.g. 10000 pps burst.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.committed_information_rate": {
"type": "integer",
"description": "The committed information rate is the guaranteed packets rate for\ntraffic arriving or departing under normal conditions.\nE.g. 10000 pps.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 10000000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.policer_mode": {
"type": "string",
"description": "- POLICER_MODE_NOT_SHARED: Not Shared\n\nA separate policer instance is created for each reference to the policer\n- POLICER_MODE_SHARED: Shared\n\nA common policer instance is used for for all references to the policer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "POLICER_MODE_NOT_SHARED"
},
"spec.policer_type": {
"type": "string",
"description": "Specifies the type of Policer\n\nBasic Single-Rate Two-Color Policer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "POLICER_SINGLE_RATE_TWO_COLOR"
}
}
},
{
"name": "list_policers",
"description": "List Policer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/policers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_policer",
"description": "DELETE Policer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/policers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a policer",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.policer.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for policerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for policerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "rate_limiting"
}
},
{
"name": "get_policer",
"description": "GET Policer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/policers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"policy-based-routings": {
"name": "policy-based-routings",
"displayName": "Policy Based Routings",
"operations": [
{
"name": "create_policy_based_routing",
"description": "Create Policy based Routing.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/policy_based_routings",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of policy_based_routing",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.policy_based_routing.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/viewspolicy_based_routingCreateSpecType"
}
],
"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 policy_based_routingCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for policy_based_routingCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for policy_based_routingCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Network Policy based routing create specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.forward_proxy_pbr": {
"type": "object",
"description": "Network(L3/L4) routing policy rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.forward_proxy_pbr.forward_proxy_pbr_rules": {
"type": "array",
"description": "Network(L3/L4) routing policy rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.forwarding_class_list": {
"type": "array",
"description": "Ordered list of forwarding Class to be used if source application match and no rule match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 3,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.network_pbr": {
"type": "object",
"description": "Network(L3/L4) routing policy rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.network_pbr_rules": {
"type": "array",
"description": "Network(L3/L4) routing policy rule.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.policy_choice": [
"forward_proxy_pbr",
"network_pbr"
],
"spec.network_pbr.source_choice": [
"any",
"label_selector",
"prefix_list"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_policy_based_routing",
"description": "Replace Policy based Routing.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/policy_based_routings/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a policy_based_routing",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.policy_based_routing.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/viewspolicy_based_routingReplaceSpecType"
}
],
"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 policy_based_routingReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for policy_based_routingReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for policy_based_routingReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Network Policy based routing replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.forward_proxy_pbr": {
"type": "object",
"description": "Network(L3/L4) routing policy rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.forward_proxy_pbr.forward_proxy_pbr_rules": {
"type": "array",
"description": "Network(L3/L4) routing policy rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.forwarding_class_list": {
"type": "array",
"description": "Ordered list of forwarding Class to be used if source application match and no rule match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 3,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.network_pbr": {
"type": "object",
"description": "Network(L3/L4) routing policy rule.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.label_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.network_pbr_rules": {
"type": "array",
"description": "Network(L3/L4) routing policy rule.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.network_pbr.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.policy_choice": [
"forward_proxy_pbr",
"network_pbr"
],
"spec.network_pbr.source_choice": [
"any",
"label_selector",
"prefix_list"
]
}
},
{
"name": "list_policy_based_routings",
"description": "List Policy based Routing.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/policy_based_routings",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_policy_based_routing",
"description": "DELETE Policy based Routing.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/policy_based_routings/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a policy_based_routing",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.policy_based_routing.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for policy_based_routingDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for policy_based_routingDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_policy_based_routing",
"description": "GET Policy based Routing.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/policy_based_routings/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"pool-members-health-status": {
"name": "pool-members-health-status",
"displayName": "Pool Members Health Status",
"operations": [
{
"name": "list_pool_members_health_status",
"description": "DNS Load Balancer Pool Members Health Status List.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/dns_load_balancers/pool_members_health_status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Collection of DNS Load Balancer Pool Member Health Status."
}
]
}
]
},
	"priority": {
"name": "priority",
"displayName": "Priority",
"operations": [
{
"name": "create_priority",
"description": "Change priority of a ticket.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/customer_support/{name}/priority",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Changes priority of an existing customer support ticket.",
"title": "Request to change ticket priority",
"x-displayname": "Customer support ticket change priority request.",
"x-ves-proto-message": "ves.io.schema.customer_support.PriorityRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to have its priority changed.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the customer support ticket object to have its priority changed.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"priority": {
"allOf": [
{
"$ref": "#/components/schemas/customer_supportSupportTicketPriority"
}
],
"x-f5xc-example": "10",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Changes priority of an existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportPriorityRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportPriorityRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportPriorityRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to have its priority changed.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"priority": {
"type": "string",
"description": "Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "PRIORITY_UNKNOWN"
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"protocol-inspections": {
"name": "protocol-inspections",
"displayName": "Protocol Inspections",
"operations": [
{
"name": "create_protocol_inspection",
"description": "Create Protocol Inspection.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/protocol_inspections",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of protocol_inspection",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.protocol_inspection.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/protocol_inspectionCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Protocol inspection for compliance checks and signature-based detection",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.enable_disable_compliance_checks",
"spec.enable_disable_signatures"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: protocol_inspection\nmetadata:\n  name: example-inspection\n  namespace: default\nspec:\n  enable_disable_compliance_checks:\n    disable_compliance_checks: {}\n  enable_disable_signatures:\n    enable_signature: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-inspection\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"enable_disable_compliance_checks\": {\n      \"disable_compliance_checks\": {}\n    },\n    \"enable_disable_signatures\": {\n      \"enable_signature\": {}\n    }\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-inspection",
"namespace": "default"
},
"spec": {
"enable_disable_compliance_checks": {
"disable_compliance_checks": {}
},
"enable_disable_signatures": {
"enable_signature": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.enable_disable_compliance_checks",
"spec.enable_disable_signatures"
],
"description": "Protocol inspection for compliance checks and signature-based detection"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Protocol Inspection Specification in a given namespace. If one already exists it will give an error.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "Action after inspection\n\n- ALLOW: Allow\n\nAllow traffic\n- DENY: Deny\n\nThrow RST error for TCP and ICMP error for UDP\n- DROP: DROP\n\nSilently drop traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ALLOW"
},
"spec.enable_disable_compliance_checks": {
"type": "object",
"description": "Enable Disable Compliance Checks Choice.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_compliance_checks.disable_compliance_checks": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_compliance_checks.enable_compliance_checks": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_signatures": {
"type": "object",
"description": "Enable Disable Signature Choice.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_signatures.disable_signature": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_signatures.enable_signature": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.enable_disable_compliance_checks.compliance_check_choice": [
"disable_compliance_checks",
"enable_compliance_checks"
],
"spec.enable_disable_signatures.signature_choice": [
"disable_signature",
"enable_signature"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_protocol_inspection",
"description": "Replace Protocol Inspection.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/protocol_inspections/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a protocol_inspection",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.protocol_inspection.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/protocol_inspectionReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Protocol inspection for compliance checks and signature-based detection",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.enable_disable_compliance_checks",
"spec.enable_disable_signatures"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: protocol_inspection\nmetadata:\n  name: example-inspection\n  namespace: default\nspec:\n  enable_disable_compliance_checks:\n    disable_compliance_checks: {}\n  enable_disable_signatures:\n    enable_signature: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-inspection\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"enable_disable_compliance_checks\": {\n      \"disable_compliance_checks\": {}\n    },\n    \"enable_disable_signatures\": {\n      \"enable_signature\": {}\n    }\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-inspection",
"namespace": "default"
},
"spec": {
"enable_disable_compliance_checks": {
"disable_compliance_checks": {}
},
"enable_disable_signatures": {
"enable_signature": {}
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.enable_disable_compliance_checks",
"spec.enable_disable_signatures"
],
"description": "Protocol inspection for compliance checks and signature-based detection"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Protocol Inspection specification in a given namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "Action after inspection\n\n- ALLOW: Allow\n\nAllow traffic\n- DENY: Deny\n\nThrow RST error for TCP and ICMP error for UDP\n- DROP: DROP\n\nSilently drop traffic.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ALLOW"
},
"spec.enable_disable_compliance_checks": {
"type": "object",
"description": "Enable Disable Compliance Checks Choice.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_compliance_checks.disable_compliance_checks": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_compliance_checks.enable_compliance_checks": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_signatures": {
"type": "object",
"description": "Enable Disable Signature Choice.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_signatures.disable_signature": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_disable_signatures.enable_signature": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.enable_disable_compliance_checks.compliance_check_choice": [
"disable_compliance_checks",
"enable_compliance_checks"
],
"spec.enable_disable_signatures.signature_choice": [
"disable_signature",
"enable_signature"
]
}
},
{
"name": "list_protocol_inspections",
"description": "List Configure Protocol Inspection.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/protocol_inspections",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_protocol_inspection",
"description": "DELETE Configure Protocol Inspection.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/protocol_inspections/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a protocol_inspection",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.protocol_inspection.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for protocol_inspectionDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for protocol_inspectionDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_protocol_inspection",
"description": "GET Protocol Inspection.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/protocol_inspections/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"protocol-policers": {
"name": "protocol-policers",
"displayName": "Protocol Policers",
"operations": [
{
"name": "create_protocol_policer",
"description": "Create Protocol Policer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/protocol_policers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of protocol_policer",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.protocol_policer.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/protocol_policerCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Rate limiter policy for controlling request rates to protected endpoints",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-rl\n  namespace: default\nspec:\n  burst_size: 1\n  committed_information_rate: 1\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-rl\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"burst_size\": 1,\n    \"committed_information_rate\": 1\n  }\n}\n"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-rl",
"namespace": "default"
},
"spec": {
"burst_size": 1,
"committed_information_rate": 1
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"description": "Rate limiter policy for controlling request rates to protected endpoints"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a protocol_policer object, protocol_policer object contains list\nof L4 protocol match condition and corresponding traffic rate limits.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_policer": {
"type": "array",
"description": "List of L4 protocol match condition and associated traffic rate limits.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_protocol_policer",
"description": "Replace Protocol Policer.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/protocol_policers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a protocol_policer",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.protocol_policer.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/protocol_policerReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Rate limiter policy for controlling request rates to protected endpoints",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-rl\n  namespace: default\nspec:\n  burst_size: 1\n  committed_information_rate: 1\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-rl\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"burst_size\": 1,\n    \"committed_information_rate\": 1\n  }\n}\n"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-rl",
"namespace": "default"
},
"spec": {
"burst_size": 1,
"committed_information_rate": 1
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.burst_size",
"spec.committed_information_rate"
],
"description": "Rate limiter policy for controlling request rates to protected endpoints"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a protocol_policer object with new L4 protocol match condition and\ncorresponding traffic rate limits.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.protocol_policer": {
"type": "array",
"description": "List of L4 protocol match condition and associated traffic rate limits.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_protocol_policers",
"description": "List Protocol Policer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/protocol_policers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_protocol_policer",
"description": "DELETE Protocol Policer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/protocol_policers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a protocol_policer",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.protocol_policer.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for protocol_policerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for protocol_policerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "rate_limiting"
}
},
{
"name": "get_protocol_policer",
"description": "GET Protocol Policer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/protocol_policers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"proxys": {
"name": "proxys",
"displayName": "Proxys",
"operations": [
{
"name": "create_proxy",
"description": "Create Proxy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/proxys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of proxy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.proxy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsproxyCreateSpecType"
}
],
"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 proxyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for proxyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for proxyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the TCP loadbalancer create specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies.forward_proxy_policies": {
"type": "array",
"description": "Ordered List of Forward Proxy Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.disable_dns_masquerade": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.domains": {
"type": "array",
"description": "A list of Domains to be proxied.\nWildcard hosts are supported in the suffix or prefix form\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.enable_dns_masquerade": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.http_proxy": {
"type": "object",
"description": "Parameters for dynamic HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.https_proxy": {
"type": "object",
"description": "Parameters for dynamic HTTPS proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.sni_proxy": {
"type": "object",
"description": "Parameters for dynamic SNI proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_proxy": {
"type": "object",
"description": "Parameters for HTTP Connect Proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_proxy.enable_http": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_proxy.more_option": {
"type": "object",
"description": "This defines various OPTIONS to define a route.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_forward_proxy_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_interception": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_virtual_sites": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_virtual_sites.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tls_intercept": {
"type": "object",
"description": "Configuration to enable TLS interception.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.custom_certificate": {
"type": "object",
"description": "Handle to fetch certificate and key.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.enable_for_all_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.policy": {
"type": "object",
"description": "Policy to enable or disable TLS interception.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.trusted_ca_url": {
"type": "string",
"description": "Exclusive with [volterra_trusted_ca]\nCustom Root CA Certificate for validating upstream server certificate.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 131072,
"byteLength": {
"max": 131072
},
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.volterra_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.volterra_trusted_ca": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.network_choice": [
"site_local_inside_network",
"site_local_network"
],
"spec.proxy_choice": [
"dynamic_proxy",
"http_proxy"
],
"spec.proxy_policy_choice": [
"active_forward_proxy_policies",
"no_forward_proxy_policy"
],
"spec.site_choice": [
"do_not_advertise",
"site_virtual_sites"
],
"spec.tls_interception_choice": [
"no_interception",
"tls_intercept"
],
"spec.dynamic_proxy.dns_choice": [
"disable_dns_masquerade",
"enable_dns_masquerade"
],
"spec.dynamic_proxy.proxy_choice": [
"http_proxy",
"https_proxy",
"sni_proxy"
],
"spec.http_proxy.http_https_choice": [
"enable_http"
],
"spec.http_proxy.more_option.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.http_proxy.more_option.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.http_proxy.more_option.strict_sni_host_header_check_choice": [],
"spec.tls_intercept.interception_policy_choice": [
"enable_for_all_domains",
"policy"
],
"spec.tls_intercept.signing_cert_choice": [
"custom_certificate",
"volterra_certificate"
],
"spec.tls_intercept.trusted_ca_choice": [
"trusted_ca_url",
"volterra_trusted_ca"
],
"spec.tls_intercept.custom_certificate.ocsp_stapling_choice": [
"custom_hash_algorithms",
"disable_ocsp_stapling",
"use_system_defaults"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_proxy",
"description": "Replace Proxy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/proxys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a proxy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.proxy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsproxyReplaceSpecType"
}
],
"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 proxyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for proxyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for proxyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the TCP loadbalancer replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies.forward_proxy_policies": {
"type": "array",
"description": "Ordered List of Forward Proxy Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1800000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.disable_dns_masquerade": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.domains": {
"type": "array",
"description": "A list of Domains to be proxied.\nWildcard hosts are supported in the suffix or prefix form\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.enable_dns_masquerade": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.http_proxy": {
"type": "object",
"description": "Parameters for dynamic HTTP proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.https_proxy": {
"type": "object",
"description": "Parameters for dynamic HTTPS proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_proxy.sni_proxy": {
"type": "object",
"description": "Parameters for dynamic SNI proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_proxy": {
"type": "object",
"description": "Parameters for HTTP Connect Proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_proxy.enable_http": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_proxy.more_option": {
"type": "object",
"description": "This defines various OPTIONS to define a route.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_forward_proxy_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_interception": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_virtual_sites": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_virtual_sites.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tls_intercept": {
"type": "object",
"description": "Configuration to enable TLS interception.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.custom_certificate": {
"type": "object",
"description": "Handle to fetch certificate and key.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.enable_for_all_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.policy": {
"type": "object",
"description": "Policy to enable or disable TLS interception.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.trusted_ca_url": {
"type": "string",
"description": "Exclusive with [volterra_trusted_ca]\nCustom Root CA Certificate for validating upstream server certificate.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 131072,
"byteLength": {
"max": 131072
},
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.volterra_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_intercept.volterra_trusted_ca": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.network_choice": [
"site_local_inside_network",
"site_local_network"
],
"spec.proxy_choice": [
"dynamic_proxy",
"http_proxy"
],
"spec.proxy_policy_choice": [
"active_forward_proxy_policies",
"no_forward_proxy_policy"
],
"spec.site_choice": [
"do_not_advertise",
"site_virtual_sites"
],
"spec.tls_interception_choice": [
"no_interception",
"tls_intercept"
],
"spec.dynamic_proxy.dns_choice": [
"disable_dns_masquerade",
"enable_dns_masquerade"
],
"spec.dynamic_proxy.proxy_choice": [
"http_proxy",
"https_proxy",
"sni_proxy"
],
"spec.http_proxy.http_https_choice": [
"enable_http"
],
"spec.http_proxy.more_option.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.http_proxy.more_option.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.http_proxy.more_option.strict_sni_host_header_check_choice": [],
"spec.tls_intercept.interception_policy_choice": [
"enable_for_all_domains",
"policy"
],
"spec.tls_intercept.signing_cert_choice": [
"custom_certificate",
"volterra_certificate"
],
"spec.tls_intercept.trusted_ca_choice": [
"trusted_ca_url",
"volterra_trusted_ca"
],
"spec.tls_intercept.custom_certificate.ocsp_stapling_choice": [
"custom_hash_algorithms",
"disable_ocsp_stapling",
"use_system_defaults"
]
}
},
{
"name": "list_proxys",
"description": "List Proxy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/proxys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_proxy",
"description": "DELETE Proxy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/proxys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a proxy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.proxy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for proxyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for proxyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_proxy",
"description": "GET Proxy",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/proxys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"public-ips": {
"name": "public-ips",
"displayName": "Public Ips",
"operations": [
{
"name": "replace_public_ip",
"description": "Replace Public IP.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/public_ips/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a public_ip",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.public_ip.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/public_ipReplaceSpecType"
}
],
"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 public_ipReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for public_ipReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for public_ipReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an public_ip object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_sites": {
"type": "array",
"description": "Reference to virtual_site where this pubic IP will be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_public_ips",
"description": "List Public IP.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/public_ips",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_public_ip",
"description": "GET Public IP.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/public_ips/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"pvc-metrics": {
"name": "pvc-metrics",
"displayName": "Pvc Metrics",
"operations": [
{
"name": "create_pvc_metric",
"description": "PVC Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/virtual_k8s/pvc/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the metrics for PVC.",
"title": "PVC Metrics Request",
"x-displayname": "PVC Metrics Request.",
"x-ves-proto-message": "ves.io.schema.virtual_k8s.PVCMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/virtual_k8sPVCMetricType"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.",
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in MetricLabel {PVC, SITE} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{PVC=\\\"pvc-1\\\"}",
"x-f5xc-example": "\"{PVC=\\\"pvc-1\\\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in MetricLabel {PVC, SITE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = : equal to != ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {NAMESPACE, PVC, SITE}",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/virtual_k8sPVCMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by zero or more labels {NAMESPACE, PVC, SITE}.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_k8sPVCMetricsRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_k8sPVCMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for virtual_k8sPVCMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in MetricLabel {PVC, SITE} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {NAMESPACE, PVC, SITE}",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series metric data for PVC."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"quotas": {
"name": "quotas",
"displayName": "Quotas",
"operations": [
{
"name": "create_quota",
"description": "Create Quota.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/quotas",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of quota",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.quota.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/schemaquotaCreateSpecType"
}
],
"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 quotaCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for quotaCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for quotaCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create quota creates a given object from storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_limits": {
      "type": "object",
"description": "API Limits defines ratelimit parameters for an API at the stdlib service\nThe key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\"",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.object_limits": {
"type": "object",
"description": "Object Limits define maximum number of instances that can be present per object kind for the tenant\nThe key of the object_limits map is object kind e.g. \"virtual_host\"",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.resource_limits": {
"type": "object",
"description": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of\nthe resource limits is the resource name.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_quota",
"description": "Replace Quota.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/quotas/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a quota",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.quota.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/schemaquotaReplaceSpecType"
}
],
"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 quotaReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for quotaReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for quotaReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace quota updates a given object from storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_limits": {
      "type": "object",
"description": "API Limits defines ratelimit parameters for an API at the stdlib service\nThe key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\"",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.object_limits": {
"type": "object",
"description": "Object Limits define maximum number of instances that can be present per object kind for the tenant\nThe key of the object_limits map is object kind e.g. \"virtual_host\"",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.resource_limits": {
"type": "object",
"description": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of\nthe resource limits is the resource name.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_quotas",
"description": "List Quota.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/quotas",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_quota",
"description": "DELETE Quota.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/quotas/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a quota",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.quota.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for quotaDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for quotaDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
}
},
{
"name": "get_quota",
"description": "GET Quota",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/quotas/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"rate-limit-suggestion": {
"name": "rate-limit-suggestion",
"displayName": "Rate Limit Suggestion",
"operations": [
{
"name": "create_rate_limit_suggestion",
"description": "Suggest rate limit rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/http_loadbalancers/{name}/rate_limit/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested rate limit rule for a given path.",
"title": "GetSuggestedRateLimitRuleReq",
"x-displayname": "GET Suggested Rate Limit Rule Request.",
"x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedRateLimitRuleReq",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this rate limit rule applied.",
"title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this rate limit rule applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the rate limit to.",
"title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested rate limit rule for a given path.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedRateLimitRuleReq",
"required_fields": [
"path"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedRateLimitRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  path: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"path\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"path": "value"
}
},
"requiredFields": [
"path"
],
"description": "Minimum configuration for app_securityGetSuggestedRateLimitRuleReq"
},
"fieldMetadata": {
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this rate limit rule applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the rate limit to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"rate-limiter-policys": {
"name": "rate-limiter-policys",
"displayName": "Rate Limiter Policys",
"operations": [
{
"name": "create_rate_limiter_policy",
"description": "Create Specification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/rate_limiter_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of rate_limiter_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.rate_limiter_policy.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/viewsrate_limiter_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Rate limiter policy for controlling request rates to protected endpoints",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: rate_limiter_policy\nmetadata:\n  name: example-rl\n  namespace: default\nspec:\n  any_server: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-rl\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"any_server\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-rl",
"namespace": "default"
},
"spec": {
"any_server": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Rate limiter policy for controlling request rates to protected endpoints"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Rate Limiter Policy Create specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_server": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "A list of RateLimiterRules that are evaluated sequentially till a matching rule is identified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name": {
"type": "string",
"description": "Exclusive with [any_server server_name_matcher server_selector]\nThe expected name of the server. The actual names for the server are extracted from the HTTP Host header and the name of the virtual_host for the request.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.server_choice": [
"any_server",
"server_name",
"server_name_matcher",
"server_selector"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_rate_limiter_policy",
"description": "Replace Specification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/rate_limiter_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a rate_limiter_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.rate_limiter_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewsrate_limiter_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Rate limiter policy for controlling request rates to protected endpoints",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: rate_limiter_policy\nmetadata:\n  name: example-rl\n  namespace: default\nspec:\n  any_server: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-rl\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"any_server\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-rl",
"namespace": "default"
},
"spec": {
"any_server": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Rate limiter policy for controlling request rates to protected endpoints"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Rate Limiter Policy Replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_server": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "A list of RateLimiterRules that are evaluated sequentially till a matching rule is identified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name": {
"type": "string",
"description": "Exclusive with [any_server server_name_matcher server_selector]\nThe expected name of the server. The actual names for the server are extracted from the HTTP Host header and the name of the virtual_host for the request.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.server_choice": [
"any_server",
"server_name",
"server_name_matcher",
"server_selector"
]
}
},
{
"name": "list_rate_limiter_policys",
"description": "List Rate Limiter Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/rate_limiter_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_rate_limiter_policy",
"description": "DELETE Rate Limiter Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/rate_limiter_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a rate_limiter_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.rate_limiter_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rate_limiter_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rate_limiter_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "rate_limiting"
}
},
{
"name": "get_rate_limiter_policy",
"description": "GET Specification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/rate_limiter_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"rate-limiters": {
"name": "rate-limiters",
"displayName": "Rate Limiters",
"operations": [
{
"name": "create_rate_limiter",
"description": "Create Rate Limiter.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/rate_limiters",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of rate_limiter",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.rate_limiter.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/rate_limiterCreateSpecType"
}
],
"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 rate_limiterCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rate_limiterCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for rate_limiterCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create rate_limiter creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.limits": {
"type": "array",
"description": "A list of RateLimitValues that specifies the total number of allowed requests for each specified period.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_identification": {
"type": "array",
"description": "A reference to user_identification object.\nThe rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_rate_limiter",
"description": "Replace Rate Limiter.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/rate_limiters/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a rate_limiter",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.rate_limiter.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/rate_limiterReplaceSpecType"
}
],
"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 rate_limiterReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rate_limiterReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "rate_limiting"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for rate_limiterReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace rate_limiter replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.limits": {
"type": "array",
"description": "A list of RateLimitValues that specifies the total number of allowed requests for each specified period.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_identification": {
"type": "array",
"description": "A reference to user_identification object.\nThe rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_rate_limiters",
"description": "List Rate Limiter.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/rate_limiters",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_rate_limiter",
"description": "DELETE Rate Limiter.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/rate_limiters/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a rate_limiter",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.rate_limiter.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rate_limiterDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rate_limiterDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "rate_limiting"
}
},
{
"name": "get_rate_limiter",
"description": "GET Rate Limiter.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/rate_limiters/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"rbac-policys": {
"name": "rbac-policys",
"displayName": "Rbac Policys",
"operations": [
{
"name": "list_rbac_policys",
"description": "List RBAC Policy.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/rbac_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_rbac_policy",
"description": "GET RBAC Policy.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/rbac_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"register": {
"name": "register",
"displayName": "Register",
"operations": [
{
"name": "create_register",
"description": "Create Registration.",
"method": "POST",
"path": "/api/register/namespaces/{namespace}/registrations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of registration",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.registration.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/schemaregistrationCreateSpecType"
}
],
"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 registrationCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for registrationCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "VPM creates registration using this message, never used by users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra": {
"type": "object",
"description": "InfraMetadata stores information about instance infrastructure.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.availability_zone": {
"type": "string",
"description": "An Availability Zone is a high-availability offering that protects your applications and data from datacenter failures.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.bond_config": {
"type": "object",
"description": "Bond device configuration for VPM registration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.certified_hw": {
"type": "string",
"description": "Certified HW name used to map with F5XC certified_hardware definition.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.domain": {
"type": "string",
"description": "Machine domain. It's used for Kubernetes cloud provider when domain must be\ndifferent than F5 Distributed Cloud.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.hostname": {
"type": "string",
"description": "Must be unique in entire cluster and same as OS settings.\n'.' (dots) are not allowed in hostname.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.infra.hw_info": {
"type": "object",
"description": "OsInfo holds information about host OS and HW.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.instance_id": {
"type": "string",
"description": "Instance ID (assigned by infrastructure provider)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.interfaces": {
"type": "object",
"description": "Machine interfaces present during registration time.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.infra.internet_proxy": {
"type": "object",
"description": "Proxy describes OPTIONS for HTTP or HTTPS proxy configurations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.is_slo_static": {
"type": "boolean",
"description": "Indicates whether the SLO is static.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.machine_id": {
"type": "string",
"description": "Machine ID - generated by operating system.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.provider": {
"type": "string",
"description": "Infrastructure provider enum for registration. It describes where is instance running.\n\nProvider was not detected\nAWS cloud instance\nGoogle cloud instance\nAzure cloud instance\nVMWare VM\nKVM VM\nOther provider, which was not identified by system.\nF5XC HW device.\nIBM Cloud instance.\nKubernetes cluster in AWS\nKubernetes cluster in GCP\nKubernetes cluster in Azure\nKubernetes cluster in Vmware\nKubernetes cluster in VMware\nKubernetes cluster in Other provider\nKubernetes cluster in F5 Distributed Cloud\nKubernetes cluster in IBM Cloud\nF5OS HW device.\nRSeries Device\nOCI Cloud Instance\nNutanix instance\nOpenStack Instance\nEquinix Instance\nOpenShift Virtualization Instance.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNKNOWN"
},
"spec.infra.sw_info": {
"type": "object",
"description": "SWInfo holds information about sw version.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.timestamp": {
"type": "string",
"description": "It's used to verify machine have acceptable time difference from server.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "date-time",
"minLength": 20,
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$",
"formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.zone": {
"type": "string",
"description": "Instance zone (or region), depends on provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport": {
"type": "object",
"description": "Passport stores information about identification and node configuration provided by CE during registration. It can be manually updated by user during approval.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.cluster_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.cluster_size": {
"type": "integer",
"description": "Defines how many master nodes is in the cluster, only 1 or 3 is allowed\n1 - cluster have single master, without HA\n3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won't start until ALL nodes are ADMITTED\n0 - same as 1\nThis value can't be changed after installation.\nIt does not interact with auto-scaling as only pool nodes are scaled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.cluster_type": {
"type": "string",
"description": "Cluster or grouping configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.latitude": {
"type": "number",
"description": "Geographic location of this site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.longitude": {
"type": "number",
"description": "Geographic location of this site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nOperating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.private_network_name": {
"type": "string",
"description": "Private Network name for private access connectivity to F5XC ADN.\nIt is used for PrivateLink, CloudLink and L3VPN.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nF5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.token": {
      "type": "string",
"description": "Token is used for machine and tenant identification.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.passport.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.passport.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_register",
"description": "Replace Registration.",
"method": "PUT",
"path": "/api/register/namespaces/{namespace}/registrations/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a registration",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.registration.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/schemaregistrationReplaceSpecType"
}
],
"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 registrationReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for registrationReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "NO fields are allowed to be replaced.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_register",
"description": "List Registration.",
"method": "GET",
"path": "/api/register/namespaces/{namespace}/registrations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_register",
"description": "DELETE Registration.",
"method": "DELETE",
"path": "/api/register/namespaces/{namespace}/registrations/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fail_if_referred",
"in": "query",
"required": false,
"type": "boolean"
}
]
},
{
"name": "get_register",
"description": "GET Registration.",
"method": "GET",
"path": "/api/register/namespaces/{namespace}/registrations/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "object",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"register-approve": {
"name": "register-approve",
"displayName": "Register Approve",
"operations": [
{
"name": "create_register_approve",
"description": "Registration Approve.",
"method": "POST",
"path": "/api/register/namespaces/{namespace}/registration/{name}/approve",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for admission approval.",
"title": "Approval request",
"x-displayname": "Approval",
"x-ves-proto-message": "ves.io.schema.registration.ApprovalReq",
"properties": {
"annotations": {
"type": "object",
"description": "Optional.\nAnnotations to set (add if missing, overwrite if exists)",
"title": "Annotations",
"x-displayname": "Annotations.",
"x-ves-example": "Key:value",
      "x-f5xc-example": "key:value",
      "x-f5xc-description-short": "Optional. Annotations to set (add if missing, overwrite if exists)",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"backup_connected_region": {
"type": "string",
"description": "Optional.\nBackup RE connection for CE(s)",
"title": "Connected Region",
"x-displayname": "Backup Connected Region.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Optional. Backup RE connection for CE(s)",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"connected_region": {
"type": "string",
"description": "Optional.\nClosest REs to which to connect in selected region. If there is more than one RE with the label\nthen select 2 of them. Otherwise default \"geo-IP\" database is consulted to find closest RE(s) to\npublic IP with which node registration request was received.",
"title": "Connected Region",
"x-displayname": "Connected Region.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Optional. Closest REs to which to connect in selected region.",
"x-f5xc-description-medium": "Optional. Closest REs to which to connect in selected region. If there is more than one RE with the label then select 2 of them. Otherwise default \"geo-IP\" database is consulted to find closest RE(s) to public IP with which node registration request was received.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"labels": {
"type": "object",
"description": "Optional.\nLabels to set (add if missing, overwrite if exists)",
"title": "Labels",
"x-displayname": "Labels",
"x-ves-example": "Key:value",
      "x-f5xc-example": "key:value",
      "x-f5xc-description-short": "Optional. Labels to set (add if missing, overwrite if exists)",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Registration name (= \"r-\" + uid) to approve. Registration name is taken from listing pending registrations.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "R-00000000-0000-4000-8000-946fdf7ca6a3.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "r-00000000-0000-4000-8000-946fdf7ca6a3",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Registration name (= \"r-\" + uid) to approve. Registration name is taken from listing pending registrations.",
"x-f5xc-description-medium": "Registration name (= \"r-\" + uid) to approve. Registration name is taken from listing pending registrations.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"passport": {
"allOf": [
{
"$ref": "#/components/schemas/registrationPassport"
}
],
"x-ves-required": "true",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"preferred_active_re": {
"type": "string",
"description": "Optional.\nPreferred Active RE connection for CE(s) using private VN.",
"title": "Preferred Active RE",
"x-displayname": "Preferred Active RE.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Optional. Preferred Active RE connection for CE(s) using private VN.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tunnel_type": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSiteToSiteTunnelType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for registrationApprovalReq",
"required_fields": [
"name",
"passport"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationApprovalReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  passport: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"passport\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"passport": "value"
}
},
"requiredFields": [
"name",
"passport"
],
"description": "Minimum configuration for registrationApprovalReq"
},
"fieldMetadata": {
"annotations": {
"type": "object",
"description": "Optional.\nAnnotations to set (add if missing, overwrite if exists)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"backup_connected_region": {
"type": "string",
"description": "Optional.\nBackup RE connection for CE(s)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"connected_region": {
"type": "string",
"description": "Optional.\nClosest REs to which to connect in selected region. If there is more than one RE with the label\nthen select 2 of them. Otherwise default \"geo-IP\" database is consulted to find closest RE(s) to\npublic IP with which node registration request was received.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"labels": {
"type": "object",
"description": "Optional.\nLabels to set (add if missing, overwrite if exists)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Registration name (= \"r-\" + uid) to approve. Registration name is taken from listing pending registrations.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"passport": {
"type": "object",
"description": "Passport stores information about identification and node configuration provided by CE during registration. It can be manually updated by user during approval.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"passport.cluster_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"passport.cluster_size": {
"type": "integer",
"description": "Defines how many master nodes is in the cluster, only 1 or 3 is allowed\n1 - cluster have single master, without HA\n3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won't start until ALL nodes are ADMITTED\n0 - same as 1\nThis value can't be changed after installation.\nIt does not interact with auto-scaling as only pool nodes are scaled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"passport.cluster_type": {
"type": "string",
"description": "Cluster or grouping configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"passport.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"passport.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"passport.latitude": {
"type": "number",
"description": "Geographic location of this site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"passport.longitude": {
"type": "number",
"description": "Geographic location of this site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"passport.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nOperating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"passport.private_network_name": {
"type": "string",
"description": "Private Network name for private access connectivity to F5XC ADN.\nIt is used for PrivateLink, CloudLink and L3VPN.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"passport.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nF5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"preferred_active_re": {
"type": "string",
"description": "Optional.\nPreferred Active RE connection for CE(s) using private VN.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tunnel_type": {
"type": "string",
"description": "Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL.\nTunnel is of type IPsec\nTunnel is of type SSL.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL"
}
},
"oneOfVariants": {
"passport.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"passport.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
},
"responseSummary": [
{
"field": "obj",
"type": "object",
"description": ""
}
]
}
]
},
	"register-get-cloud-init-config": {
"name": "register-get-cloud-init-config",
"displayName": "Register Get Cloud Init Config",
"operations": [
{
"name": "list_register_get_cloud_init_config",
"description": "GET Cloud Init Config.",
"method": "GET",
"path": "/api/register/namespaces/system/get-cloud-init-config",
      "dangerLevel": "low",
"parameters": [
{
"name": "provider",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "site_name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "enable_management_network",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {
"cloud_init_config": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "cloud_init_config",
"type": "string",
"description": "Cloud-init config."
}
]
}
]
},
	"register-get-image-download-url": {
"name": "register-get-image-download-url",
"displayName": "Register Get Image Download Url",
"operations": [
{
"name": "create_register_get_image_download_url",
"description": "GET Image Download URL.",
"method": "POST",
"path": "/api/register/namespaces/system/get-image-download-url",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to GET image download URL.",
"title": "Get Image Download Url request",
"x-displayname": "GET Image Download URL Request.",
"x-ves-proto-message": "ves.io.schema.registration.GetImageDownloadUrlReq",
"properties": {
"provider": {
"type": "string",
"description": "Provider for that image.",
"title": "Provider",
"x-displayname": "Provider",
"x-ves-example": "Kvm",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-recommended-value": "KVM",
"x-f5xc-description-medium": "Deployment platform identifier for the requested Customer Edge image.",
"x-f5xc-example": "kvm",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for registrationGetImageDownloadUrlReq",
"required_fields": [
"provider"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationGetImageDownloadUrlReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  provider: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"provider\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {
"image_download_url": {
"type": "string"
},
"image_md5_download_url": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"provider": "value"
}
},
"requiredFields": [
"provider"
],
"description": "Minimum configuration for registrationGetImageDownloadUrlReq"
},
"fieldMetadata": {
"provider": {
"type": "string",
"description": "Provider for that image.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"recommendedValue": "KVM"
}
},
"responseSummary": [
{
"field": "image_download_url",
"type": "string",
"description": "URL of image download."
},
{
"field": "image_md5_download_url",
"type": "string",
"description": "URL of image md5 download."
}
]
}
]
},
	"register-get-registrations-by-token": {
"name": "register-get-registrations-by-token",
      "displayName": "Register Get Registrations By Token",
      "operations": [
{
"name": "create_register_get_registrations_by_token",
      "description": "GET Registration UID by Site Token.",
      "method": "POST",
"path": "/api/register/namespaces/system/get-registrations-by-token",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to GET registration uuids by site token.",
      "title": "Get registration uuids by site token request",
      "x-displayname": "GET Registration UUIDs by Site Token Request.",
      "x-ves-proto-message": "ves.io.schema.registration.GetRegistrationsBySiteTokenReq",
      "properties": {
"site_token": {
      "type": "string",
"description": "Site token to query on.",
      "title": "Site token",
      "x-displayname": "Site Token.",
      "x-ves-example": "00000000-0000-4000-8000-f4a29bc68178.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "00000000-0000-4000-8000-f4a29bc68178",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET registration uuids by site token.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for registrationGetRegistrationsBySiteTokenReq",
      "required_fields": [
"site_token"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationGetRegistrationsBySiteTokenReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  site_token: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"site_token\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {
"registration_uuids": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"site_token": "value"
      }
},
"requiredFields": [
"site_token"
      ],
"description": "Minimum configuration for registrationGetRegistrationsBySiteTokenReq"
      },
"fieldMetadata": {
"site_token": {
      "type": "string",
"description": "Site token to query on.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "registration_uuids",
"type": "array",
"description": "Registration UUIDs that uses the site token."
      }
]
}
]
},
	"register-registerBootstrap": {
"name": "register-registerBootstrap",
"displayName": "Register Registerbootstrap",
"operations": [
{
"name": "create_register_registerBootstrap",
"description": "Registration Create.",
"method": "POST",
"path": "/api/register/registerBootstrap",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Register node. This API isn't designed to be used by users, it's only for node.",
      "title": "Create registration",
"x-displayname": "Create registration.",
"x-ves-proto-message": "ves.io.schema.registration.RegistrationCreateRequest",
"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/schemaregistrationCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Register node. This API isn't designed to be used by users, it's only for node.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for registrationRegistrationCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationRegistrationCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for registrationRegistrationCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "VPM creates registration using this message, never used by users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra": {
"type": "object",
"description": "InfraMetadata stores information about instance infrastructure.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.availability_zone": {
"type": "string",
"description": "An Availability Zone is a high-availability offering that protects your applications and data from datacenter failures.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.bond_config": {
"type": "object",
"description": "Bond device configuration for VPM registration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.certified_hw": {
"type": "string",
"description": "Certified HW name used to map with F5XC certified_hardware definition.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.domain": {
"type": "string",
"description": "Machine domain. It's used for Kubernetes cloud provider when domain must be\ndifferent than F5 Distributed Cloud.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.hostname": {
"type": "string",
"description": "Must be unique in entire cluster and same as OS settings.\n'.' (dots) are not allowed in hostname.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.infra.hw_info": {
"type": "object",
"description": "OsInfo holds information about host OS and HW.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.instance_id": {
"type": "string",
"description": "Instance ID (assigned by infrastructure provider)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.interfaces": {
"type": "object",
"description": "Machine interfaces present during registration time.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.infra.internet_proxy": {
"type": "object",
"description": "Proxy describes OPTIONS for HTTP or HTTPS proxy configurations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.is_slo_static": {
"type": "boolean",
"description": "Indicates whether the SLO is static.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.machine_id": {
"type": "string",
"description": "Machine ID - generated by operating system.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.provider": {
"type": "string",
"description": "Infrastructure provider enum for registration. It describes where is instance running.\n\nProvider was not detected\nAWS cloud instance\nGoogle cloud instance\nAzure cloud instance\nVMWare VM\nKVM VM\nOther provider, which was not identified by system.\nF5XC HW device.\nIBM Cloud instance.\nKubernetes cluster in AWS\nKubernetes cluster in GCP\nKubernetes cluster in Azure\nKubernetes cluster in Vmware\nKubernetes cluster in VMware\nKubernetes cluster in Other provider\nKubernetes cluster in F5 Distributed Cloud\nKubernetes cluster in IBM Cloud\nF5OS HW device.\nRSeries Device\nOCI Cloud Instance\nNutanix instance\nOpenStack Instance\nEquinix Instance\nOpenShift Virtualization Instance.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNKNOWN"
},
"spec.infra.sw_info": {
"type": "object",
"description": "SWInfo holds information about sw version.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.timestamp": {
"type": "string",
"description": "It's used to verify machine have acceptable time difference from server.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"format": "date-time",
"minLength": 20,
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$",
"formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.infra.zone": {
"type": "string",
"description": "Instance zone (or region), depends on provider.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport": {
"type": "object",
"description": "Passport stores information about identification and node configuration provided by CE during registration. It can be manually updated by user during approval.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.cluster_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.cluster_size": {
"type": "integer",
"description": "Defines how many master nodes is in the cluster, only 1 or 3 is allowed\n1 - cluster have single master, without HA\n3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won't start until ALL nodes are ADMITTED\n0 - same as 1\nThis value can't be changed after installation.\nIt does not interact with auto-scaling as only pool nodes are scaled.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.cluster_type": {
"type": "string",
"description": "Cluster or grouping configuration",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.latitude": {
"type": "number",
"description": "Geographic location of this site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.longitude": {
"type": "number",
"description": "Geographic location of this site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.passport.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nOperating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.private_network_name": {
"type": "string",
"description": "Private Network name for private access connectivity to F5XC ADN.\nIt is used for PrivateLink, CloudLink and L3VPN.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.passport.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nF5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.token": {
      "type": "string",
"description": "Token is used for machine and tenant identification.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.passport.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.passport.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"register-requestConfig": {
"name": "register-requestConfig",
"displayName": "Register Requestconfig",
"operations": [
{
"name": "create_register_requestConfig",
"description": "Registration Config.",
"method": "POST",
"path": "/api/register/requestConfig",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to GET configuration.",
"title": "Configuration request",
"x-displayname": "Configuration Request.",
"x-ves-proto-message": "ves.io.schema.registration.ConfigReq",
"properties": {
"name": {
"type": "string",
"description": "Registration name.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "R-00000000-0000-4000-8000-946fdf7ca6a3.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "r-00000000-0000-4000-8000-946fdf7ca6a3",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Registration namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"token": {
      "type": "string",
"description": "Token - verify node identity.",
      "title": "Token",
      "x-displayname": "Token",
      "x-ves-example": "00000000-0000-4000-8000-ce47f538482c.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "00000000-0000-4000-8000-ce47f538482c",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for registrationConfigReq",
"required_fields": [
"name",
"namespace",
"token"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationConfigReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  token: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"token\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {
"hash": {
"type": "string"
},
"workload": {
"type": "object"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"token": "value"
      }
},
"requiredFields": [
"name",
"namespace",
"token"
      ],
"description": "Minimum configuration for registrationConfigReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Registration name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Registration namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"token": {
      "type": "string",
"description": "Token - verify node identity.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "hash",
"type": "string",
"description": "Hash of workload map which is used to verify consistency\nand check changes."
},
{
"field": "workload",
"type": "object",
"description": "Configuration for applications and infrastructure."
}
]
}
]
},
	"register-state": {
"name": "register-state",
"displayName": "Register State",
"operations": [
{
"name": "create_register_state",
"description": "Set site state.",
"method": "POST",
"path": "/api/register/namespaces/{namespace}/site/{name}/state",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Set status of the site.",
"title": "Set state request",
"x-displayname": "Set Status Request.",
"x-ves-proto-message": "ves.io.schema.site.SetStateReq",
"properties": {
"name": {
"type": "string",
"description": "Site name",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Ce398",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ce398",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Site namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/siteSiteState"
}
],
"x-f5xc-example": "running",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteSetStateReq",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteSetStateReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for siteSetStateReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Site name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Site namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"state": {
"type": "string",
"description": "State of Site defines in which operational state site itself is.\n\nSite is online and operational.\nSite is in provisioning state. For instance during site deployment or switching to different connected Regional Edge.\nSite is in process of upgrade. It transition to ONLINE or FAILED state.\nSite is in Standby before goes to ONLINE. This is mainly for Regional Edge sites to do their verification before they go to ONLINE state.\nSite is in failed state. It failed during provisioning or upgrade phase. Site Status Objects contain more details.\nReregistration was requested\nReregistration is in progress and maurice is waiting for nodes\nSite deletion is in progress\nSite is waiting for registration\nSite resources are waiting to be orchestrated for F5XC managed site. Check Status objects for more details\nSite resources are orchestrated for F5XC managed site.\nAn Error occurred while site resource orchestration for F5XC managed site. Check Status objects for more details.\nSite resources are waiting to be orchestrated for F5XC managed site. Check Status objects for more details\nSite resources orchestrated for F5XC managed site are deleted.\nAn Error occurred while site resource DELETE operation for F5XC managed site. Check Status objects for more details.\nValidation for F5XC managed site is in progress. Check Status objects for more details.\nValidation for F5XC managed site succeeded. Orchestration will start for Site resources\nValidation for F5XC managed site failed. Check Status objects for more details.\nSite is in failed state for prolong period of time. Site Status Objects contain more details.\nSite resources are waiting to be updated. Check Status objects for more details\nAn Error occurred while updating cloud resources for F5XC managed site. Check Status objects for more details.\nSite resources orchestration is queued for F5XC managed site. Check Status objects for more details\nSite resources update is queued for F5XC managed site. Check Status objects for more details\nSite resources DELETE is queued for F5XC managed site. Check Status objects for more details.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ONLINE"
}
}
}
]
},
	"register-suggest-values": {
"name": "register-suggest-values",
"displayName": "Register Suggest Values",
"operations": [
{
"name": "create_register_suggest_value",
"description": "Suggest Values.",
"method": "POST",
"path": "/api/register/namespaces/system/suggest-values",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of SuggestValues request.",
"title": "SuggestValuesReq",
"x-displayname": "Request for SuggestValues.",
"x-ves-proto-message": "ves.io.schema.registration.SuggestValuesReq",
"properties": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"title": "field_path",
"maxLength": 1024,
"x-displayname": "Field Path.",
"x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match",
      "x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"title": "match_value",
"maxLength": 256,
"x-displayname": "Match Value.",
"x-ves-example": "Some-substring.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "some-substring",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"request_body": {
"allOf": [
{
"$ref": "#/components/schemas/protobufAny"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for registrationSuggestValuesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for registrationSuggestValuesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for registrationSuggestValuesReq"
},
"fieldMetadata": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body": {
"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\": <string>,\n\"lastName\": <string>\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}",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.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.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.value": {
"type": "string",
"description": "Must be a valid serialized protocol buffer of the above specified type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of suggested items."
}
]
}
]
},
	"released-signatures": {
"name": "released-signatures",
"displayName": "Released Signatures",
"operations": [
{
"name": "list_released_signatures",
"description": "Released Signatures.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_hosts/{vh_name}/released_signatures",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "vh_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"release_signatures": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "release_signatures",
"type": "array",
"description": "Release Signatures."
}
]
}
]
},
	"remove-from-inventory": {
"name": "remove-from-inventory",
"displayName": "Remove From Inventory",
"operations": [
{
"name": "create_remove_from_inventory",
"description": "Remove From API Inventory.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}/remove_from_inventory",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for various API Inventory Requests.",
      "title": "API Inventory Request",
      "x-displayname": "API Inventory Request.",
      "x-ves-proto-message": "ves.io.schema.views.api_definition.APInventoryReq",
      "properties": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "title": "API Endpoints",
      "minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/viewsApiOperation"
      },
"x-displayname": "API Endpoints.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "The list of API endpoints for the API Inventory request.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "title": "Name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for various API Inventory Requests.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_definitionAPInventoryReq",
      "required_fields": [
"api_endpoints"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_definitionAPInventoryReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  api_endpoints: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"api_endpoints\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"updated_api_endpoints": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"api_endpoints": "value"
      }
},
"requiredFields": [
"api_endpoints"
      ],
"description": "Minimum configuration for api_definitionAPInventoryReq"
      },
"fieldMetadata": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "updated_api_endpoints",
      "type": "array",
"description": "The list of API endpoints which were successfully proceeded by the API Inventory request."
      }
]
}
]
},
	"reopen": {
"name": "reopen",
"displayName": "Reopen",
"operations": [
{
"name": "create_reopen",
"description": "Reopen a closed customer support ticket.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/customer_support/{name}/reopen",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Reopens a closed existing customer support ticket.",
"title": "Reopen comment request",
"x-displayname": "Customer support ticket reopen request.",
"x-ves-proto-message": "ves.io.schema.customer_support.ReopenRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be open again.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "The name of the customer support ticket object to be open again.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Reopens a closed existing customer support ticket.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for customer_supportReopenRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for customer_supportReopenRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for customer_supportReopenRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the customer support ticket object to be open again.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the support ticket object is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "err",
"type": "object",
"description": ""
}
]
}
]
},
	"report": {
"name": "report",
"displayName": "Report",
"operations": [
{
"name": "create_report",
"description": "Create Report Configuration.",
"method": "POST",
"path": "/api/report/namespaces/{namespace}/report_configs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of report_config",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.report_config.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/report_configCreateSpecType"
}
],
"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 report_configCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for report_configCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Report configuration is used to schedule report generation at a later point in time.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.report_recipients": {
"type": "object",
"description": "Report recipients.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.report_recipients.user_groups": {
"type": "array",
"description": "Select one or more user groups, to which the report should be sent via email.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap": {
"type": "object",
"description": "Report Type Waap.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.current_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.daily": {
"type": "object",
"description": "Create report daily.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.monthly": {
"type": "object",
"description": "Create report monthly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.namespaces": {
"type": "object",
"description": "Namespaces.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.weekly": {
"type": "object",
"description": "Create report weekly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.report_type": [
"bot_defense",
"waap"
],
"spec.waap.report_frequency": [
"daily",
"monthly",
"weekly"
],
"spec.waap.report_namespaces": [
"current_namespace",
"namespaces"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_report",
"description": "Replace Report Configuration.",
"method": "PUT",
"path": "/api/report/namespaces/{namespace}/report_configs/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a report_config",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.report_config.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/report_configReplaceSpecType"
}
],
"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 report_configReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for report_configReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Report Configuration.\n\nUpdate the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.report_recipients": {
"type": "object",
"description": "Report recipients.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.report_recipients.user_groups": {
"type": "array",
"description": "Select one or more user groups, to which the report should be sent via email.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap": {
"type": "object",
"description": "Report Type Waap.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.current_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.daily": {
"type": "object",
"description": "Create report daily.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.monthly": {
"type": "object",
"description": "Create report monthly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.namespaces": {
"type": "object",
"description": "Namespaces.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waap.weekly": {
"type": "object",
"description": "Create report weekly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.report_type": [
"bot_defense",
"waap"
],
"spec.waap.report_frequency": [
"daily",
"monthly",
"weekly"
],
"spec.waap.report_namespaces": [
"current_namespace",
"namespaces"
]
}
},
{
"name": "list_report",
"description": "List Report Configuration.",
"method": "GET",
"path": "/api/report/namespaces/{namespace}/report_configs",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_report",
"description": "DELETE Report Configuration.",
"method": "DELETE",
"path": "/api/report/namespaces/{namespace}/report_configs/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a report_config",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.report_config.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for report_configDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
}
},
{
"name": "get_report",
"description": "GET Report Configuration.",
"method": "GET",
"path": "/api/report/namespaces/{namespace}/report_configs/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"report-download": {
"name": "report-download",
"displayName": "Report Download",
"operations": [
{
"name": "list_report_download",
"description": "Download Report.",
"method": "GET",
"path": "/api/report/namespaces/{namespace}/reports/{name}/download",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"Attachments": {
"type": "array"
},
"css_data": {
"type": "string"
},
"html_data": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "Attachments",
"type": "array",
"description": "Attachments for email."
},
{
"field": "css_data",
"type": "string",
"description": "Report data in CSS."
},
{
"field": "html_data",
"type": "string",
"description": "Report data in HTML."
}
]
}
]
},
	"report-generate": {
"name": "report-generate",
"displayName": "Report Generate",
"operations": [
{
"name": "create_report_generate",
"description": "Generate Report Now.",
"method": "POST",
"path": "/api/report/namespaces/{namespace}/report_configs/{name}/generate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Generate report request.",
"title": "Generate Report Request",
"x-displayname": "Generate Report Request.",
"x-ves-proto-message": "ves.io.schema.report_config.GenerateReportRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the report config for which report has to be generated.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Test-report.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "test-report",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of the report config for which report has to be generated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for report_configGenerateReportRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configGenerateReportRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for report_configGenerateReportRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the report config for which report has to be generated.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"report-list-reports-history": {
"name": "report-list-reports-history",
"displayName": "Report List Reports History",
"operations": [
{
"name": "create_report_list_reports_history",
"description": "List Reports History.",
"method": "POST",
"path": "/api/report/namespaces/{namespace}/report_configs/list-reports-history",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "List Reports for the current namespace for the requested report configuration names.",
"title": "List Reports Request",
"x-displayname": "List Reports Request.",
"x-ves-oneof-field-report_configuration_names": "[\"include_all\",\"report_config_names\"]",
"x-ves-proto-message": "ves.io.schema.report_config.ListReportsHistoryRequest",
"properties": {
"include_all": {
"type": "boolean",
"description": "Exclusive with [report_config_names]\ninclude all configuration names.",
"title": "Include All configuration names",
"format": "boolean",
"x-displayname": "Include all configuration names.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Exclusive with [report_config_names] include all configuration names.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"report_config_names": {
"allOf": [
{
"$ref": "#/components/schemas/report_configReportConfigurationNamesList"
}
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "List Reports for the current namespace for the requested report configuration names.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for report_configListReportsHistoryRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configListReportsHistoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
},
"reports": {
"type": "array"
},
"reports_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for report_configListReportsHistoryRequest"
},
"fieldMetadata": {
"include_all": {
"type": "boolean",
"description": "Exclusive with [report_config_names]\ninclude all configuration names.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"report_config_names": {
"type": "object",
"description": "ReportConfigurationNamesList.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"report_config_names.names": {
"type": "array",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"report_configuration_names": [
"include_all",
"report_config_names"
]
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Report objects."
},
{
"field": "reports",
"type": "array",
"description": "Report objects."
},
{
"field": "reports_list",
"type": "array",
"description": "Report objects."
}
]
}
]
},
	"report-list-reports-history-bot-defence": {
"name": "report-list-reports-history-bot-defence",
"displayName": "Report List Reports History Bot Defence",
"operations": [
{
"name": "create_report_list_reports_history_bot_defence",
"description": "List Reports History Bot Defence.",
"method": "POST",
"path": "/api/report/namespaces/{namespace}/report_configs/list-reports-history-bot-defence",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "List Reports for the current namespace for the requested report configuration names.",
"title": "List Reports Request",
"x-displayname": "List Reports Request.",
"x-ves-oneof-field-report_configuration_names": "[\"include_all\",\"report_config_names\"]",
"x-ves-proto-message": "ves.io.schema.report_config.ListReportsHistoryRequest",
"properties": {
"include_all": {
"type": "boolean",
"description": "Exclusive with [report_config_names]\ninclude all configuration names.",
"title": "Include All configuration names",
"format": "boolean",
"x-displayname": "Include all configuration names.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Exclusive with [report_config_names] include all configuration names.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"report_config_names": {
"allOf": [
{
"$ref": "#/components/schemas/report_configReportConfigurationNamesList"
}
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "List Reports for the current namespace for the requested report configuration names.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for report_configListReportsHistoryRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configListReportsHistoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
},
"reports": {
"type": "array"
},
"reports_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for report_configListReportsHistoryRequest"
},
"fieldMetadata": {
"include_all": {
"type": "boolean",
"description": "Exclusive with [report_config_names]\ninclude all configuration names.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"report_config_names": {
"type": "object",
"description": "ReportConfigurationNamesList.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"report_config_names.names": {
"type": "array",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"report_configuration_names": [
"include_all",
"report_config_names"
]
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Report objects."
},
{
"field": "reports",
"type": "array",
"description": "Report objects."
},
{
"field": "reports_list",
"type": "array",
"description": "Report objects."
}
]
}
]
},
	"report-list-reports-history-waap": {
"name": "report-list-reports-history-waap",
"displayName": "Report List Reports History Waap",
"operations": [
{
"name": "create_report_list_reports_history_waap",
"description": "List Reports History Waap.",
"method": "POST",
"path": "/api/report/namespaces/{namespace}/report_configs/list-reports-history-waap",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "List Reports for the current namespace for the requested report configuration names.",
"title": "List Reports Request",
"x-displayname": "List Reports Request.",
"x-ves-oneof-field-report_configuration_names": "[\"include_all\",\"report_config_names\"]",
"x-ves-proto-message": "ves.io.schema.report_config.ListReportsHistoryRequest",
"properties": {
"include_all": {
"type": "boolean",
"description": "Exclusive with [report_config_names]\ninclude all configuration names.",
"title": "Include All configuration names",
"format": "boolean",
"x-displayname": "Include all configuration names.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Exclusive with [report_config_names] include all configuration names.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"report_config_names": {
"allOf": [
{
"$ref": "#/components/schemas/report_configReportConfigurationNamesList"
}
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "List Reports for the current namespace for the requested report configuration names.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for report_configListReportsHistoryRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for report_configListReportsHistoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
},
"reports": {
"type": "array"
},
"reports_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for report_configListReportsHistoryRequest"
},
"fieldMetadata": {
"include_all": {
"type": "boolean",
"description": "Exclusive with [report_config_names]\ninclude all configuration names.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for this request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"report_config_names": {
"type": "object",
"description": "ReportConfigurationNamesList.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"report_config_names.names": {
"type": "array",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"report_configuration_names": [
"include_all",
"report_config_names"
]
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Report objects."
},
{
"field": "reports",
"type": "array",
"description": "Report objects."
},
{
"field": "reports_list",
"type": "array",
"description": "Report objects."
}
]
}
]
},
	"request-logs": {
"name": "request-logs",
"displayName": "Request Logs",
"operations": [
{
"name": "create_request_log",
"description": "GET DNS Zone Request Logs.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/dns_zones/request_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch request logs.",
"title": "DnsZoneRequestLogRequest",
"x-displayname": "DNS Zone Request Log Request.",
"x-ves-proto-message": "ves.io.schema.dns_zone.DnsZoneRequestLogRequest",
"properties": {
"end_time": {
"type": "string",
"description": "Fetch request logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch request logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch request logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{COUNTRY_CODE=\\\"CH\\\"}",
"x-f5xc-example": "\"{COUNTRY_CODE=\\\"CH\\\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not equal to Optional: If...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "0",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "0",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch request logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch request logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch request logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch request logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch request logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_zoneDnsZoneRequestLogRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_zoneDnsZoneRequestLogRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object",
"properties": {
"logs": {
"type": "array"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_zoneDnsZoneRequestLogRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "Fetch request logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch request logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"start_time": {
"type": "string",
"description": "Fetch request logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"revoke-global-kubeconfigs": {
"name": "revoke-global-kubeconfigs",
"displayName": "Revoke Global Kubeconfigs",
"operations": [
{
"name": "create_revoke_global_kubeconfig",
"description": "Revoke Global Kubeconfig.",
"method": "POST",
"path": "/api/web/namespaces/system/revoke/global-kubeconfigs",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Revoke kubeconfig object with a given name.",
"title": "Revoke Kubeconfig request",
"x-displayname": "Revoke Kubeconfig Request.",
"x-ves-proto-message": "ves.io.schema.site.RevokeKubeConfigReq",
"properties": {
"name": {
"type": "string",
"description": "Name of kubeconfig resource.",
"title": "Credential name",
      "minLength": 1,
"maxLength": 64,
"x-displayname": "Name",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"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.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64,
"min": 1
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Revoke kubeconfig object with a given name.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteRevokeKubeConfigReq",
"required_fields": [
"name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteRevokeKubeConfigReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value"
}
},
"requiredFields": [
"name"
],
"description": "Minimum configuration for siteRevokeKubeConfigReq"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of kubeconfig resource.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64,
"min": 1
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "boolean",
"description": "Result status flag."
}
]
}
]
},
	"roles": {
"name": "roles",
"displayName": "Roles",
"operations": [
{
"name": "create_role",
"description": "Create Role.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/roles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of role",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.role.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/roleCreateSpecType"
}
],
"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 roleCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for roleCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for roleCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a role.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_role",
"description": "Replace Role.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/roles/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a role",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.role.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/roleReplaceSpecType"
}
],
"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 roleReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for roleReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for roleReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Amends a role.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_roles",
"description": "List Role",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/roles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_role",
"description": "DELETE Role.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/roles/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a role",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.role.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for roleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for roleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_role",
"description": "GET Role",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/roles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"routes": {
"name": "routes",
"displayName": "Routes",
"operations": [
{
"name": "create_route",
"description": "Create Route.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/routes",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of route",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.route.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/schemarouteCreateSpecType"
}
],
"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 routeCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for routeCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for routeCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create route object in a given namespace. Route object is list of route rules.\nEach rule has match condition to match incoming requests and actions to take on matching requests.\nVirtual host object has reference to route object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "List of routes to match for incoming request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 257,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_route",
"description": "Replace Route.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/routes/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a route",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.route.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/schemarouteReplaceSpecType"
}
],
"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 routeReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for routeReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for routeReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace route object in a given namespace. Route object is list of route rules.\nEach rule has match condition to match incoming requests and actions to take on matching requests.\nVirtual host object has reference to route object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "List of routes to match for incoming request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 257,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_routes",
"description": "List Route.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/routes",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_route",
"description": "DELETE Route.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/routes/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a route",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.route.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for routeDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for routeDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_route",
"description": "GET Route",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/routes/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"rtip-internal": {
"name": "rtip-internal",
"displayName": "Rtip Internal",
"operations": [
{
"name": "list_rtip_internal",
"description": "GET RTIP internal instructions.",
"method": "GET",
"path": "/api/web/namespaces/system/rtip_internal",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"internal_notes": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "internal_notes",
"type": "string",
"description": "Internal notes or special handling procedures meant exclusively for F5 Support Groups."
}
]
},
{
"name": "replace_rtip_internal",
"description": "Update RTIP internal instructions.",
"method": "PUT",
"path": "/api/web/namespaces/system/rtip_internal",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request message for updating internal RTIP instructions and labels.\nAccessible only to F5 Support groups.",
      "title": "UpdateRTIPInternalRequest",
"x-displayname": "Update Internal RTIP request.",
"x-ves-proto-message": "ves.io.schema.rtip.UpdateRTIPInternalRequest",
"properties": {
"internal_notes": {
"type": "string",
"description": "Internal text notes or handling guidelines meant only for F5 Support groups.",
"title": "Internal Instructions",
"minLength": 1,
"maxLength": 10000,
"x-displayname": "Internal Incident Handling Instructions.",
"x-ves-example": "If this tenant is impacted, escalate to SecOps Tier 2 immediately.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "10000",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "^\\\\S.*\\\\S$|^\\\\S$"
},
"x-f5xc-example": "If this tenant is impacted, escalate to SecOps Tier 2 immediately.",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "10000",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.pattern": "^\\\\S.*\\\\S$|^\\\\S$"
},
"x-f5xc-description-short": "Internal text notes or handling guidelines meant only for F5 Support groups.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 10000,
"pattern": "^\\\\S.*\\\\S$|^\\\\S$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request message for updating internal RTIP instructions and labels. Accessible only to F5 Support groups.",
      "x-f5xc-description-medium": "Request message for updating internal RTIP instructions and labels. Accessible only to F5 Support groups.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rtipUpdateRTIPInternalRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rtipUpdateRTIPInternalRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for rtipUpdateRTIPInternalRequest"
},
"fieldMetadata": {
"internal_notes": {
"type": "string",
"description": "Internal text notes or handling guidelines meant only for F5 Support groups.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 10000,
"pattern": "^\\\\S.*\\\\S$|^\\\\S$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"rule-suggestion-api-endpoint-protection": {
"name": "rule-suggestion-api-endpoint-protection",
      "displayName": "Rule Suggestion Api Endpoint Protection",
      "operations": [
{
"name": "create_rule_suggestion_api_endpoint_protection",
      "description": "Suggest API endpoint protection rule.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_sec/rule_suggestion/api_endpoint_protection",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested API endpoint protection rule for a given path.",
      "title": "GetSuggestedAPIEndpointProtectionRuleReq",
      "x-displayname": "GET Suggested API endpoint protection Rule Request.",
      "x-ves-proto-message": "ves.io.schema.api_sec.rule_suggestion.GetSuggestedAPIEndpointProtectionRuleReq",
      "properties": {
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the API endpoint protection to.",
      "title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-description-short": "Path to apply the API endpoint protection to.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this API endpoint protection rule applied.",
      "title": "Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ves-io-frontend",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Virtual Host for which this API endpoint protection rule applied.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested API endpoint protection rule for a given path.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rule_suggestionGetSuggestedAPIEndpointProtectionRuleReq",
      "required_fields": [
"namespace",
"path",
"virtual_host_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rule_suggestionGetSuggestedAPIEndpointProtectionRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  path: value\n  virtual_host_name: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"path\": \"value\",\n    \"virtual_host_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"path": "value",
"virtual_host_name": "value"
}
},
"requiredFields": [
"namespace",
"path",
"virtual_host_name"
],
"description": "Minimum configuration for rule_suggestionGetSuggestedAPIEndpointProtectionRuleReq"
      },
"fieldMetadata": {
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the API endpoint protection to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this API endpoint protection rule applied.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "loadbalancer_type",
"type": "object",
"description": ""
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"rule-suggestion-data-exposure": {
"name": "rule-suggestion-data-exposure",
"displayName": "Rule Suggestion Data Exposure",
"operations": [
{
"name": "create_rule_suggestion_data_exposure",
"description": "Suggest sensitive data rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/api_sec/rule_suggestion/data_exposure",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested sensitive data rule for a given path.",
"title": "GetSuggestedSensitiveDataRuleReq",
"x-displayname": "GET Suggested Sensitive Data Rule Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.rule_suggestion.GetSuggestedSensitiveDataRuleReq",
      "properties": {
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the sensitive data to.",
"title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this sensitive data rule applied.",
"title": "Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ves-io-frontend",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Virtual Host for which this sensitive data rule applied.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested sensitive data rule for a given path.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rule_suggestionGetSuggestedSensitiveDataRuleReq",
"required_fields": [
"namespace",
"path",
"virtual_host_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rule_suggestionGetSuggestedSensitiveDataRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  path: value\n  virtual_host_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"path\": \"value\",\n    \"virtual_host_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"path": "value",
"virtual_host_name": "value"
}
},
"requiredFields": [
"namespace",
"path",
"virtual_host_name"
],
"description": "Minimum configuration for rule_suggestionGetSuggestedSensitiveDataRuleReq"
},
"fieldMetadata": {
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the sensitive data to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this sensitive data rule applied.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "loadbalancer_type",
"type": "object",
"description": ""
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"rule-suggestion-oas-validation": {
"name": "rule-suggestion-oas-validation",
"displayName": "Rule Suggestion Oas Validation",
"operations": [
{
"name": "create_rule_suggestion_oas_validation",
"description": "Suggest Open API specification validation rule.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_sec/rule_suggestion/oas_validation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested Open API specification validation for a given path.",
      "title": "GetSuggestedOasValidationRuleReq",
"x-displayname": "GET Suggested Open API specification validation Rule Request.",
      "x-ves-proto-message": "ves.io.schema.api_sec.rule_suggestion.GetSuggestedOasValidationRuleReq",
      "properties": {
"api_groups": {
      "type": "array",
"description": "List of API Groups the API Endpoint is a member of.",
      "title": "API Groups membership",
      "items": {
"type": "string"
},
"x-displayname": "API Groups membership.",
      "x-f5xc-example": "[\"group-1\", \"group-2\"]",
"x-f5xc-description-short": "List of API Groups the API Endpoint is a member of.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the Open API specification validation to.",
      "title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-description-short": "Path to apply the Open API specification validation to.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this Open API specification validation rule applied.",
      "title": "Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ves-io-frontend",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Virtual Host for which this Open API specification validation rule applied.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested Open API specification validation for a given path.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rule_suggestionGetSuggestedOasValidationRuleReq",
"required_fields": [
"namespace",
"path",
"virtual_host_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rule_suggestionGetSuggestedOasValidationRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  path: value\n  virtual_host_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"path\": \"value\",\n    \"virtual_host_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"path": "value",
"virtual_host_name": "value"
}
},
"requiredFields": [
"namespace",
"path",
"virtual_host_name"
],
"description": "Minimum configuration for rule_suggestionGetSuggestedOasValidationRuleReq"
},
"fieldMetadata": {
"api_groups": {
      "type": "array",
"description": "List of API Groups the API Endpoint is a member of.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the Open API specification validation to.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this Open API specification validation rule applied.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "all_endpoints_oas_validation",
"type": "object",
"description": ""
},
{
"field": "custom_oas_validation",
"type": "object",
"description": ""
},
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "loadbalancer_type",
"type": "object",
"description": ""
}
]
}
]
},
	"rule-suggestion-rate-limit": {
"name": "rule-suggestion-rate-limit",
"displayName": "Rule Suggestion Rate Limit",
"operations": [
{
"name": "create_rule_suggestion_rate_limit",
"description": "Suggest rate limit rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/api_sec/rule_suggestion/rate_limit",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested rate limit rule for a given path.",
"title": "GetSuggestedRateLimitRuleReq",
"x-displayname": "GET Suggested Rate Limit Rule Request.",
"x-ves-proto-message": "ves.io.schema.api_sec.rule_suggestion.GetSuggestedRateLimitRuleReq",
      "properties": {
"method": {
"allOf": [
{
"$ref": "#/components/schemas/schemaHttpMethod"
}
],
"x-f5xc-example": "GET",
"x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "shared",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"path": {
"type": "string",
"description": "Path to apply the rate limit to.",
"title": "Path",
"maxLength": 1024,
"x-displayname": "Request Path.",
"x-ves-example": "/example",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-example": "/example",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "1024",
"ves.io.schema.rules.string.templated_http_path": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this rate limit rule applied.",
"title": "Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ves-io-frontend",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Virtual Host for which this rate limit rule applied.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested rate limit rule for a given path.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for rule_suggestionGetSuggestedRateLimitRuleReq",
"required_fields": [
"namespace",
"path",
"virtual_host_name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for rule_suggestionGetSuggestedRateLimitRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  path: value\n  virtual_host_name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"path\": \"value\",\n    \"virtual_host_name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"path": "value",
"virtual_host_name": "value"
}
},
"requiredFields": [
"namespace",
"path",
"virtual_host_name"
],
"description": "Minimum configuration for rule_suggestionGetSuggestedRateLimitRuleReq"
},
"fieldMetadata": {
"method": {
"type": "string",
"description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ANY"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"path": {
"type": "string",
"description": "Path to apply the rate limit to.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[/a-zA-Z0-9._-]+$",
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"virtual_host_name": {
"type": "string",
"description": "Virtual Host for which this rate limit rule applied.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "loadbalancer_type",
"type": "object",
"description": ""
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"saas-v2-tenant-deactivate": {
"name": "saas-v2-tenant-deactivate",
"displayName": "Saas V2 Tenant Deactivate",
"operations": [
{
"name": "replace_saas_v2_tenant_deactivate",
"description": "DeactivateTenant.",
"method": "PUT",
"path": "/api/saas/namespaces/system/v2/tenant/deactivate",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to deactivate the tenant.",
"title": "DeactivateTenantRequest",
"x-displayname": "Deactivate Tenant Request.",
"x-ves-proto-message": "ves.io.schema.tenant.DeactivateTenantRequest",
"properties": {
"feedback": {
"type": "string",
"description": "Feedback from the customer related to reason of account deactivation.",
"title": "Feedback",
"x-displayname": "Feedback",
"x-ves-example": "Customers feedback.",
"x-f5xc-example": "Customers feedback",
"x-f5xc-description-short": "Feedback from the customer related to reason of account deactivation.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/tenantDeletionReason"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenantDeactivateTenantRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantDeactivateTenantRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"job_id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantDeactivateTenantRequest"
},
"fieldMetadata": {
"feedback": {
"type": "string",
"description": "Feedback from the customer related to reason of account deactivation.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"reason": {
"type": "string",
"description": "List of available reason for account deletion.\n\n- REASON_UNKNOWN: Unknown reason\n\nUnknown reason\n- REASON_SWITCH_TO_FREE_PLAN: Switch to free plan\n\nSwitch to free plan\n- REASON_NO_LONGER_NEEDED: No longer needed\n\nNo longer needed\n- REASON_NOT_JUSTIFY_COSTS: Too expensive\n\nToo expensive\n- REASON_DIFFICULT_TO_USE: Difficult to use\n\nDifficult to use.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "REASON_UNKNOWN"
}
},
"responseSummary": [
{
"field": "job_id",
"type": "string",
"description": "Job ID of the async job that triggered to process the tenant deactivation."
}
]
}
]
},
	"schemas-.*": {
"name": "schemas-.*",
"displayName": "Schemas .*",
"operations": [
{
"name": "list_schemas_.*",
"description": "GET",
"method": "GET",
"path": "/api/schemas/.*",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object"
}
}
]
},
	"scim-token": {
"name": "scim-token",
      "displayName": "Scim Token",
      "operations": [
{
"name": "create_scim_token",
      "description": "Revoke SCIM API credential.",
      "method": "POST",
"path": "/api/web/namespaces/{namespace}/revoke/scim_token",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "ScimTokenRequest is used for fetching or revoking scim token.",
      "title": "Scim Token Request",
      "x-displayname": "Scim Token Request.",
      "x-ves-proto-message": "ves.io.schema.api_credential.ScimTokenRequest",
      "properties": {
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "ScimTokenRequest is used for fetching or revoking scim token.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_credentialScimTokenRequest",
      "required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_credentialScimTokenRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for api_credentialScimTokenRequest"
      },
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "boolean",
"description": "Result status flag."
}
]
},
{
"name": "list_scim_token",
      "description": "GET Scim Token.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/scim_token",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "object",
"type": "object",
"description": ""
}
]
}
]
},
	"scim-v2-Groups": {
"name": "scim-v2-Groups",
"displayName": "Scim V2 Groups",
"operations": [
{
"name": "list_scim_v2_Groups",
"description": "List group based on filters.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/Groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "count",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"Resources": {
"type": "array"
},
"itemsPerPage": {
"type": "string"
},
"schemas": {
"type": "array"
},
"startIndex": {
"type": "string"
},
"totalResults": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "Resources",
"type": "array",
"description": "List of available groups."
},
{
"field": "itemsPerPage",
"type": "string",
"description": "ItemsPerPage The number of resources returned in a list response page."
},
{
"field": "schemas",
"type": "array",
"description": "Schema defined as per scim spec."
},
{
"field": "startIndex",
"type": "string",
"description": "StartIndex The 1-based index of the first result in the current set of list results."
},
{
"field": "totalResults",
"type": "string",
"description": "TotalGroup objects available."
}
]
},
{
"name": "create_scim_v2_Group",
"description": "Create group with users.",
"method": "POST",
"path": "/api/scim/namespaces/system/v2/Groups",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for creating group.",
"title": "CreateGroupRequest",
"x-displayname": "CreateGroupRequest.",
"x-ves-proto-message": "ves.io.schema.scim.CreateGroupRequest",
"properties": {
"displayName": {
"type": "string",
"description": "Group display name.",
"title": "displayName",
"x-displayname": "DisplayName.",
"x-ves-example": "Display name.",
"x-f5xc-example": "display name",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "External ID for the group.",
"title": "ExternalId",
"x-displayname": "ExternalId.",
"x-ves-example": "External ID.",
"x-f5xc-example": "external Id",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Defines ID of the obj.",
"title": "Id",
"x-displayname": "ID",
"x-ves-example": "ID of object in external identity provider.",
"x-f5xc-example": "id of object in external identity provider",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"members": {
"type": "array",
"description": "List of group members reference.",
"title": "members",
"items": {
"$ref": "#/components/schemas/scimGroupMembers"
},
"x-displayname": "Members",
"x-ves-example": "List group members i.e users.",
"x-f5xc-example": "List group members i.e users",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "identity",
"minItems": 0,
"maxItems": 200,
"uniqueItems": true,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/scimMeta"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas defined as per scim spec.",
"title": "schemas",
"items": {
"type": "string"
},
"x-displayname": "Schemas",
"x-ves-example": "Scim spec defined schemas.",
"x-f5xc-example": "scim spec defined schemas",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for scimCreateGroupRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for scimCreateGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"externalId": {
"type": "string"
},
"id": {
"type": "string"
},
"members": {
"type": "array"
},
"name": {
"type": "string"
},
"schemas": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for scimCreateGroupRequest"
},
"fieldMetadata": {
"displayName": {
"type": "string",
"description": "Group display name.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "External ID for the group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Defines ID of the obj.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"members": {
"type": "array",
"description": "List of group members reference.",
"constraints": {
"constraintType": "array",
"category": "identity",
"minItems": 0,
"maxItems": 200,
"uniqueItems": true,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta": {
"type": "object",
"description": "X-required\nResource meta information..",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta.created": {
"type": "string",
"description": "Create date.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.lastModified": {
"type": "string",
"description": "Last modification date and time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.location": {
"type": "string",
"description": "[x-required]\nlocation for resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.resourceType": {
"type": "string",
"description": "Type of resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.version": {
"type": "string",
"description": "Version for resource type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas defined as per scim spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "displayName",
"type": "string",
"description": "Display name for the group."
},
{
"field": "externalId",
"type": "string",
"description": "External ID for the group."
},
{
"field": "id",
"type": "string",
"description": "Unique ID for the group."
},
{
"field": "members",
"type": "array",
"description": "Users with unique ID."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "Display name for the group."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas per scim spec."
}
]
},
{
"name": "delete_scim_v2_Group",
"description": "DELETE group based on ID.",
"method": "DELETE",
"path": "/api/scim/namespaces/system/v2/Groups/{id}",
      "dangerLevel": "high",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
},
{
"name": "get_scim_v2_Group",
"description": "List group based on ID.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/Groups/{id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"externalId": {
"type": "string"
},
"id": {
"type": "string"
},
"members": {
"type": "array"
},
"name": {
"type": "string"
},
"schemas": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "displayName",
"type": "string",
"description": "Display name for the group."
},
{
"field": "externalId",
"type": "string",
"description": "External ID for the group."
},
{
"field": "id",
"type": "string",
"description": "Unique ID for the group."
},
{
"field": "members",
"type": "array",
"description": "Users with unique ID."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "Display name for the group."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas per scim spec."
}
]
},
{
"name": "update_scim_v2_Group",
"description": "PATCH group based on ID.",
"method": "PATCH",
"path": "/api/scim/namespaces/system/v2/Groups/{id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "PATCH operation to modify group.",
"title": "PatchGroupOperation",
"x-displayname": "PatchGroupOperation.",
"x-ves-proto-message": "ves.io.schema.scim.PatchGroupRequest",
"properties": {
"Operations": {
"type": "array",
"description": "Operations to modify or DELETE group.",
"title": "Operations",
"items": {
"$ref": "#/components/schemas/scimPatchOperation"
},
"x-displayname": "Operations.",
"x-ves-example": "Add, remove, replace, DELETE.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "add, remove, replace, delete",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Unique ID for the group.",
"title": "id",
"x-displayname": "ID",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas as per scim spec.",
"title": "schemas",
"items": {
"type": "string"
},
"x-displayname": "Schemas",
"x-ves-example": "Schemas per scim spec.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "schemas per scim spec",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for scimPatchGroupRequest",
"required_fields": [
"Operations",
"id",
"schemas"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for scimPatchGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  Operations: value\n  id: value\n  schemas: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"Operations\": \"value\",\n    \"id\": \"value\",\n    \"schemas\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"externalId": {
"type": "string"
},
"id": {
"type": "string"
},
"members": {
"type": "array"
},
"name": {
"type": "string"
},
"schemas": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"Operations": "value",
"id": "value",
"schemas": "value"
}
},
"requiredFields": [
"Operations",
"id",
"schemas"
],
"description": "Minimum configuration for scimPatchGroupRequest"
},
"fieldMetadata": {
"Operations": {
"type": "array",
"description": "Operations to modify or DELETE group.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Unique ID for the group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas as per scim spec.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "displayName",
"type": "string",
"description": "Display name for the group."
},
{
"field": "externalId",
"type": "string",
"description": "External ID for the group."
},
{
"field": "id",
"type": "string",
"description": "Unique ID for the group."
},
{
"field": "members",
"type": "array",
"description": "Users with unique ID."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "Display name for the group."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas per scim spec."
}
]
},
{
"name": "replace_scim_v2_Group",
"description": "Replace group based on ID.",
"method": "PUT",
"path": "/api/scim/namespaces/system/v2/Groups/{id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Group.",
"title": "Group",
"x-displayname": "Group",
"x-ves-proto-message": "ves.io.schema.scim.Group",
"properties": {
"displayName": {
"type": "string",
"description": "Display name for the group.",
"title": "displayName",
"x-displayname": "DisplayName.",
"x-ves-example": "Group display name.",
"x-f5xc-example": "group display name",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "External ID for the group.",
"title": "ExternalId",
"x-displayname": "ExternalId.",
"x-ves-example": "External ID.",
"x-f5xc-example": "external Id",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Unique ID for the group.",
"title": "id",
"x-displayname": "ID",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"members": {
"type": "array",
"description": "Users with unique ID.",
"title": "GroupMembers",
"items": {
"$ref": "#/components/schemas/scimGroupMembers"
},
"x-displayname": "GroupMembers.",
"x-ves-example": "Users with unique ID.",
"x-f5xc-example": "Users with unique Id",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "identity",
"minItems": 0,
"maxItems": 200,
"uniqueItems": true,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/scimMeta"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Display name for the group.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Group name.",
"x-f5xc-example": "group name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"schemas": {
"type": "array",
"description": "Schemas per scim spec.",
"title": "schemas",
"items": {
"type": "string"
},
"x-displayname": "Schemas",
"x-ves-example": "Schema per scim spec.",
"x-f5xc-example": "schema per scim spec.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for scimGroup",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for scimGroup\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"externalId": {
"type": "string"
},
"id": {
"type": "string"
},
"members": {
"type": "array"
},
"name": {
"type": "string"
},
"schemas": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for scimGroup"
},
"fieldMetadata": {
"displayName": {
"type": "string",
"description": "Display name for the group.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "External ID for the group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "Unique ID for the group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"members": {
"type": "array",
"description": "Users with unique ID.",
"constraints": {
"constraintType": "array",
"category": "identity",
"minItems": 0,
"maxItems": 200,
"uniqueItems": true,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta": {
"type": "object",
"description": "X-required\nResource meta information..",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta.created": {
"type": "string",
"description": "Create date.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.lastModified": {
"type": "string",
"description": "Last modification date and time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.location": {
"type": "string",
"description": "[x-required]\nlocation for resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.resourceType": {
"type": "string",
"description": "Type of resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.version": {
"type": "string",
"description": "Version for resource type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Display name for the group.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas per scim spec.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "displayName",
"type": "string",
"description": "Display name for the group."
},
{
"field": "externalId",
"type": "string",
"description": "External ID for the group."
},
{
"field": "id",
"type": "string",
"description": "Unique ID for the group."
},
{
"field": "members",
"type": "array",
"description": "Users with unique ID."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "Display name for the group."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas per scim spec."
}
]
}
]
},
	"scim-v2-ResourceTypes": {
"name": "scim-v2-ResourceTypes",
"displayName": "Scim V2 Resourcetypes",
"operations": [
{
"name": "list_scim_v2_ResourceTypes",
"description": "GET supported resources type.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/ResourceTypes",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"resources": {
"type": "array"
},
"schemas": {
"type": "array"
},
"status": {
"type": "string"
},
"totalResults": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "detail",
"type": "string",
"description": "Detail defines the details of the response status."
},
{
"field": "resources",
"type": "array",
"description": "[\n]\n[x-required]\nResources for the query."
},
{
"field": "schemas",
"type": "array",
"description": "[\n]\n[x-required]\nschemas defined by scim spec.."
},
{
"field": "status",
"type": "string",
"description": "Status defines the status code of the response."
},
{
"field": "totalResults",
"type": "string",
"description": "[\n]\n[x-required]\nNo of results for the query."
}
]
},
{
"name": "get_scim_v2_ResourceType",
"description": "GET supported resources type.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/ResourceTypes/{id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"schema": {
"type": "string"
},
"schemas": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "endpoint",
"type": "string",
"description": "[\n]\n[x-required]\nendpoint for the resource.."
},
{
"field": "id",
"type": "string",
"description": "[\n]\n[x-required]\nID of the resource."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "[\n]\n[x-required]\nname of the resource."
},
{
"field": "schema",
"type": "string",
"description": "[x-example: \"urn:ietf:params:scim:schemas:core:2.0:ResourceType]\n[x-required]\nSchema defined in scim spec.."
},
{
"field": "schemas",
"type": "array",
"description": "[\n]\n[x-required]\nschemas defined in scim spec."
}
]
}
]
},
	"scim-v2-Schemas": {
"name": "scim-v2-Schemas",
"displayName": "Scim V2 Schemas",
"operations": [
{
"name": "list_scim_v2_Schemas",
"description": "Schemas",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/Schemas",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
},
{
"name": "get_scim_v2_Schema",
"description": "Schemas By ID.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/Schemas/{id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"scim-v2-ServiceProviderConfig": {
"name": "scim-v2-ServiceProviderConfig",
"displayName": "Scim V2 Serviceproviderconfig",
"operations": [
{
"name": "list_scim_v2_ServiceProviderConfig",
"description": "List service provider configs.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/ServiceProviderConfig",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"authenticationSchemes": {
      "type": "array"
},
"documentationUri": {
"type": "string"
},
"schemas": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "authenticationSchemes",
      "type": "array",
"description": "Supported authenticationSchemes for the resource."
      },
{
"field": "bulk",
"type": "object",
"description": ""
},
{
"field": "changePassword",
      "type": "object",
"description": ""
},
{
"field": "documentationUri",
"type": "string",
"description": "URI for documentation."
},
{
"field": "etag",
"type": "object",
"description": ""
},
{
"field": "filter",
"type": "object",
"description": ""
},
{
"field": "patch",
"type": "object",
"description": ""
},
{
"field": "schemas",
"type": "array",
"description": "Schemas scim spec."
},
{
"field": "sort",
"type": "object",
"description": ""
}
]
}
]
},
	"scim-v2-Users": {
"name": "scim-v2-Users",
"displayName": "Scim V2 Users",
"operations": [
{
"name": "list_scim_v2_Users",
"description": "GET all users.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/Users",
      "dangerLevel": "low",
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "count",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"Resources": {
"type": "array"
},
"itemsPerPage": {
"type": "string"
},
"schemas": {
"type": "array"
},
"startIndex": {
"type": "string"
},
"totalResults": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "Resources",
"type": "array",
"description": "Resources representing all the user objects."
},
{
"field": "itemsPerPage",
"type": "string",
"description": "ItemsPerPage The number of resources returned in a list response page."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas for listing the user."
},
{
"field": "startIndex",
"type": "string",
"description": "StartIndex The 1-based index of the first result in the current set of list results."
},
{
"field": "totalResults",
"type": "string",
"description": "TotalResults for the search criteria."
}
]
},
{
"name": "create_scim_v2_User",
"description": "Create User with Role Assignment.",
"method": "POST",
"path": "/api/scim/namespaces/system/v2/Users",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "CreateUserRequest is the request for creating a user.",
"title": "CreateUserRequest",
"x-displayname": "CreateUserRequest.",
"x-ves-proto-message": "ves.io.schema.scim.CreateUserRequest",
"properties": {
"active": {
"type": "boolean",
"description": "Active is boolean representing if user is active or not.",
"title": "active",
"format": "boolean",
"x-displayname": "Active",
"x-ves-example": "True/false.",
"x-f5xc-example": "true/false",
"x-f5xc-description-short": "Active is boolean representing if user is active or not.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"displayName": {
"type": "string",
"description": "DisplayName refers to the name to be displayed for the user. Default is name.",
"title": "displayName",
"x-displayname": "DisplayName.",
"x-ves-example": "Rod Rob",
"x-f5xc-example": "Rod Rob",
"x-f5xc-description-short": "DisplayName refers to the name to be displayed for the user. Default is name.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"emails": {
"type": "array",
"description": "Emails can be list of emails to be used by user work, personal etc.",
"title": "emails",
"items": {
"$ref": "#/components/schemas/scimEmail"
},
"x-displayname": "Emails",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-description-short": "Emails can be list of emails to be used by user work, personal etc.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "ExternalId refers to the ID for user represented in the external system like Azure etc.",
"title": "externalId",
"x-displayname": "ExternalId.",
"x-ves-example": "Rod_123",
"x-f5xc-example": "rod_123",
"x-f5xc-description-short": "ExternalId refers to the ID for user represented in the external system like Azure etc.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"groups": {
"type": "array",
"description": "Groups to which user belongs to.",
"title": "groups",
"items": {
"$ref": "#/components/schemas/scimUserGroup"
},
"x-displayname": "Groups",
"x-ves-example": "Groupid",
"x-f5xc-example": "groupid",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/scimMeta"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/scimName"
}
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"roles": {
"type": "array",
"description": "Roles defined for the user.",
"title": "roles",
"items": {
"type": "string"
},
"x-displayname": "Roles",
"x-ves-example": "Roles",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "roles",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas represent the schema from scim spec to be used for creating the user.",
"title": "schemas",
"items": {
"type": "string"
},
"x-displayname": "Schemas",
"x-ves-example": "Urn:ietf:params:scim:schemas:core:2.0:User.",
"x-f5xc-example": "urn:ietf:params:scim:schemas:core:2.0:User",
"x-f5xc-description-short": "Schemas represent the schema from scim spec to be used for creating the user.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"userName": {
"type": "string",
"description": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.",
"title": "userName",
"x-displayname": "UserName",
"x-ves-example": "Rod_123",
"x-f5xc-example": "rod_123",
"x-f5xc-description-short": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.",
"x-f5xc-description-medium": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"userType": {
"allOf": [
{
"$ref": "#/components/schemas/userUserType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "CreateUserRequest is the request for creating a user.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for scimCreateUserRequest",
"required_fields": [
"roles"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for scimCreateUserRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  roles: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"roles\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"emails": {
"type": "array"
},
"externalId": {
"type": "string"
},
"groups": {
"type": "array"
},
"id": {
"type": "string"
},
"nickName": {
"type": "string"
},
"roles": {
"type": "array"
},
"schemas": {
"type": "array"
},
"userName": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"roles": "value"
}
},
"requiredFields": [
"roles"
],
"description": "Minimum configuration for scimCreateUserRequest"
},
"fieldMetadata": {
"active": {
"type": "boolean",
"description": "Active is boolean representing if user is active or not.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"displayName": {
"type": "string",
"description": "DisplayName refers to the name to be displayed for the user. Default is name.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"emails": {
"type": "array",
"description": "Emails can be list of emails to be used by user work, personal etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "ExternalId refers to the ID for user represented in the external system like Azure etc.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"groups": {
"type": "array",
"description": "Groups to which user belongs to.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta": {
"type": "object",
"description": "X-required\nResource meta information..",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta.created": {
"type": "string",
"description": "Create date.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.lastModified": {
"type": "string",
"description": "Last modification date and time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.location": {
"type": "string",
"description": "[x-required]\nlocation for resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.resourceType": {
"type": "string",
"description": "Type of resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.version": {
"type": "string",
"description": "Version for resource type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "object",
"description": "Name is the name of user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.familyName": {
"type": "string",
"description": "Family name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.formatted": {
"type": "string",
"description": "Formatted name is detailed name of person.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.givenName": {
"type": "string",
"description": "Given name of the person.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.honorificPrefix": {
"type": "string",
"description": "Prefix for the name. Mr Ms. Etc.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.honorificSuffix": {
"type": "string",
"description": "Suffix for the name like Jr Sr I II III etc.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.middleName": {
"type": "string",
"description": "Middle name of the person.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"roles": {
"type": "array",
"description": "Roles defined for the user.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas represent the schema from scim spec to be used for creating the user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"userName": {
"type": "string",
"description": "UserName refers to the unique userName for this user. Can be emailId or username used in yahoo gmail etc.",
"constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"userType": {
"type": "string",
"description": "UserType is to identify the type of user\n\n- USER: User\nRegular User\n- SERVICE: Service User\nUser for accessing only APIs/services\n- DEBUG: Debug\nUser which was created by tenant admin for F5 Distributed Cloud-support team.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "USER"
}
},
"responseSummary": [
{
"field": "active",
"type": "boolean",
"description": "Active specifies if user is active or not."
},
{
"field": "displayName",
"type": "string",
"description": "DisplayName for the user."
},
{
"field": "emails",
"type": "array",
"description": "Emails for the user whether primary or secondary."
},
{
"field": "externalId",
"type": "string",
"description": "ExternalId specifies the ID for the user object in external system."
},
{
"field": "groups",
"type": "array",
"description": "Groups to which user is part of."
},
{
"field": "id",
"type": "string",
"description": "ID for user object."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "object",
"description": ""
},
{
"field": "nickName",
"type": "string",
"description": "NickName for the user."
},
{
"field": "roles",
"type": "array",
"description": "Roles defined for the user."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas for user object as per scim spec 2.0."
},
{
"field": "userName",
"type": "string",
"description": "UserName for the user."
},
{
"field": "userType",
"type": "object",
"description": ""
}
]
},
{
"name": "delete_scim_v2_User",
"description": "DELETE user by ID.",
"method": "DELETE",
"path": "/api/scim/namespaces/system/v2/Users/{id}",
      "dangerLevel": "high",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
},
{
"name": "get_scim_v2_User",
"description": "GET User with ID.",
"method": "GET",
"path": "/api/scim/namespaces/system/v2/Users/{id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "excludedAttributes",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"emails": {
"type": "array"
},
"externalId": {
"type": "string"
},
"groups": {
"type": "array"
},
"id": {
"type": "string"
},
"nickName": {
"type": "string"
},
"roles": {
"type": "array"
},
"schemas": {
"type": "array"
},
"userName": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "active",
"type": "boolean",
"description": "Active specifies if user is active or not."
},
{
"field": "displayName",
"type": "string",
"description": "DisplayName for the user."
},
{
"field": "emails",
"type": "array",
"description": "Emails for the user whether primary or secondary."
},
{
"field": "externalId",
"type": "string",
"description": "ExternalId specifies the ID for the user object in external system."
},
{
"field": "groups",
"type": "array",
"description": "Groups to which user is part of."
},
{
"field": "id",
"type": "string",
"description": "ID for user object."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "object",
"description": ""
},
{
"field": "nickName",
"type": "string",
"description": "NickName for the user."
},
{
"field": "roles",
"type": "array",
"description": "Roles defined for the user."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas for user object as per scim spec 2.0."
},
{
"field": "userName",
"type": "string",
"description": "UserName for the user."
},
{
"field": "userType",
"type": "object",
"description": ""
}
]
},
{
"name": "update_scim_v2_User",
"description": "PATCH User.",
"method": "PATCH",
"path": "/api/scim/namespaces/system/v2/Users/{id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "X-example: {\n\"schemas\": [\n\"urn:ietf:params:scim:API:messages:2.0:PatchOp\"\n],\noperation\": [{\n\"op\": \"add\",\n\"path\": \"name.preferredname\",\n\"value\": \"New preferred Name\"\n}]\n},\n\"ID\": \"1234-5678-901234\"\n\n}\nPatchUserRequest patches the user object or deletes it.",
      "title": "PatchUserRequest",
"x-displayname": "PatchUserRequest.",
"x-ves-proto-message": "ves.io.schema.scim.PatchUserRequest",
"properties": {
"Operations": {
"type": "array",
"description": "\"op\": \"add\",\n\"path\": \"name.preferredname\",\n\"value\": \"new name\"\n}]\n}\"\"\noperations that will modify or DELETE the user object.",
"title": "operations",
"items": {
"$ref": "#/components/schemas/scimPatchOperation"
},
"x-displayname": "Operations.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "\"\"operations\"[{",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "\"op\": \"add\", \"path\": \"name.preferredname\", \"value\": \"new name\" }] }\"\" operations that will modify or DELETE the user object.",
"x-f5xc-description-medium": "\"op\": \"add\", \"path\": \"name.preferredname\", \"value\": \"new name\" }] }\"\" operations that will modify or DELETE the user object.",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "ID of the user object that needs patching.",
"title": "id",
"x-displayname": "ID",
"x-ves-example": "\"ID\": \"1234-5678-901234\"",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "\"\"id\"\"1234-5678-901234\"\"",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "ID of the user object that needs patching.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas for PATCH.",
"title": "schemas",
"items": {
"type": "string"
},
"x-displayname": "Schemas",
"x-ves-example": "Urn:ietf:params:scim:API:messages:2.0:PatchOp.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "urn:ietf:params:scim:api:messages:2.0:PatchOp",
      "x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for scimPatchUserRequest",
"required_fields": [
"Operations",
"id",
"schemas"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for scimPatchUserRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  Operations: value\n  id: value\n  schemas: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"Operations\": \"value\",\n    \"id\": \"value\",\n    \"schemas\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"emails": {
"type": "array"
},
"externalId": {
"type": "string"
},
"groups": {
"type": "array"
},
"id": {
"type": "string"
},
"nickName": {
"type": "string"
},
"roles": {
"type": "array"
},
"schemas": {
"type": "array"
},
"userName": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"Operations": "value",
"id": "value",
"schemas": "value"
}
},
"requiredFields": [
"Operations",
"id",
"schemas"
],
"description": "Minimum configuration for scimPatchUserRequest"
},
"fieldMetadata": {
"Operations": {
"type": "array",
"description": "\"op\": \"add\",\n\"path\": \"name.preferredname\",\n\"value\": \"new name\"\n}]\n}\"\"\noperations that will modify or DELETE the user object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "ID of the user object that needs patching.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas for PATCH.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "active",
"type": "boolean",
"description": "Active specifies if user is active or not."
},
{
"field": "displayName",
"type": "string",
"description": "DisplayName for the user."
},
{
"field": "emails",
"type": "array",
"description": "Emails for the user whether primary or secondary."
},
{
"field": "externalId",
"type": "string",
"description": "ExternalId specifies the ID for the user object in external system."
},
{
"field": "groups",
"type": "array",
"description": "Groups to which user is part of."
},
{
"field": "id",
"type": "string",
"description": "ID for user object."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "object",
"description": ""
},
{
"field": "nickName",
"type": "string",
"description": "NickName for the user."
},
{
"field": "roles",
"type": "array",
"description": "Roles defined for the user."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas for user object as per scim spec 2.0."
},
{
"field": "userName",
"type": "string",
"description": "UserName for the user."
},
{
"field": "userType",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_scim_v2_User",
"description": "Update User and Role Assignments.",
"method": "PUT",
"path": "/api/scim/namespaces/system/v2/Users/{id}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "User object representing the user created.",
"title": "User",
"x-displayname": "User",
"x-ves-proto-message": "ves.io.schema.scim.User",
"properties": {
"active": {
"type": "boolean",
"description": "Active specifies if user is active or not.",
"title": "active",
"format": "boolean",
"x-displayname": "Active",
"x-ves-example": "True/false.",
"x-f5xc-example": "true/false",
"x-f5xc-description-short": "Active specifies if user is active or not.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"displayName": {
"type": "string",
"description": "DisplayName for the user.",
"title": "displayName",
"x-displayname": "DisplayName.",
"x-ves-example": "Rodney",
"x-f5xc-example": "Rodney",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"emails": {
"type": "array",
"description": "Emails for the user whether primary or secondary.",
"title": "emails",
"items": {
"$ref": "#/components/schemas/scimEmail"
},
"x-displayname": "Emails",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-description-short": "Emails for the user whether primary or secondary.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "ExternalId specifies the ID for the user object in external system.",
"title": "externalId",
"x-displayname": "ExternalId.",
"x-ves-example": "Rod_1234",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "rod_1234",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "ExternalId specifies the ID for the user object in external system.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"groups": {
"type": "array",
"description": "Groups to which user is part of.",
"title": "groups",
"items": {
"$ref": "#/components/schemas/scimUserGroup"
},
"x-displayname": "Groups",
"x-ves-example": "Group-ID",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "group-id",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "ID for user object.",
"title": "id",
"x-displayname": "ID",
"x-ves-example": "123-456-789012.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "123-456-789012",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/scimMeta"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/scimName"
}
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"nickName": {
"type": "string",
"description": "NickName for the user.",
"title": "nickName",
"x-displayname": "NickName",
"x-ves-example": "Rod",
"x-f5xc-example": "Rod",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"roles": {
"type": "array",
"description": "Roles defined for the user.",
"title": "roles",
"items": {
"type": "string"
},
"x-displayname": "Roles",
"x-ves-example": "Roles",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "roles",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas for user object as per scim spec 2.0.",
"title": "schemas",
"items": {
"type": "string"
},
"x-displayname": "Schemas",
"x-ves-example": "Urn:ietf:params:scim:schemas:core:2.0:User.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "urn:ietf:params:scim:schemas:core:2.0:User",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Schemas for user object as per scim spec 2.0.",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"userName": {
"type": "string",
"description": "UserName for the user.",
"title": "userName",
"x-displayname": "UserName",
"x-ves-example": "Rod_1234",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "rod_1234",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"userType": {
"allOf": [
{
"$ref": "#/components/schemas/userUserType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "User object representing the user created.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for scimUser",
"required_fields": [
"externalId",
"groups",
"id",
"roles",
"schemas",
"userName"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for scimUser\nmetadata:\n  name: example\n  namespace: default\nspec:\n  externalId: value\n  groups: value\n  id: value\n  roles: value\n  schemas: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"externalId\": \"value\",\n    \"groups\": \"value\",\n    \"id\": \"value\",\n    \"roles\": \"value\",\n    \"schemas\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"displayName": {
"type": "string"
},
"emails": {
"type": "array"
},
"externalId": {
"type": "string"
},
"groups": {
"type": "array"
},
"id": {
"type": "string"
},
"nickName": {
"type": "string"
},
"roles": {
"type": "array"
},
"schemas": {
"type": "array"
},
"userName": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"externalId": "value",
"groups": "value",
"id": "value",
"roles": "value",
"schemas": "value"
}
},
"requiredFields": [
"externalId",
"groups",
"id",
"roles",
"schemas",
"userName"
],
"description": "Minimum configuration for scimUser"
},
"fieldMetadata": {
"active": {
"type": "boolean",
"description": "Active specifies if user is active or not.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"displayName": {
"type": "string",
"description": "DisplayName for the user.",
"constraints": {
"constraintType": "string",
"category": "display",
"maxLength": 1024,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"emails": {
"type": "array",
"description": "Emails for the user whether primary or secondary.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"externalId": {
"type": "string",
"description": "ExternalId specifies the ID for the user object in external system.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"groups": {
"type": "array",
"description": "Groups to which user is part of.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id": {
"type": "string",
"description": "ID for user object.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta": {
"type": "object",
"description": "X-required\nResource meta information..",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"meta.created": {
"type": "string",
"description": "Create date.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.lastModified": {
"type": "string",
"description": "Last modification date and time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.location": {
"type": "string",
"description": "[x-required]\nlocation for resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.resourceType": {
"type": "string",
"description": "Type of resource.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"meta.version": {
"type": "string",
"description": "Version for resource type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "object",
"description": "Name is the name of user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.familyName": {
"type": "string",
"description": "Family name.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.formatted": {
"type": "string",
"description": "Formatted name is detailed name of person.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.givenName": {
"type": "string",
"description": "Given name of the person.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.honorificPrefix": {
"type": "string",
"description": "Prefix for the name. Mr Ms. Etc.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.honorificSuffix": {
"type": "string",
"description": "Suffix for the name like Jr Sr I II III etc.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name.middleName": {
"type": "string",
"description": "Middle name of the person.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"nickName": {
"type": "string",
"description": "NickName for the user.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"roles": {
"type": "array",
"description": "Roles defined for the user.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"schemas": {
"type": "array",
"description": "Schemas for user object as per scim spec 2.0.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"userName": {
"type": "string",
"description": "UserName for the user.",
"constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"userType": {
"type": "string",
"description": "UserType is to identify the type of user\n\n- USER: User\nRegular User\n- SERVICE: Service User\nUser for accessing only APIs/services\n- DEBUG: Debug\nUser which was created by tenant admin for F5 Distributed Cloud-support team.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "USER"
}
},
"responseSummary": [
{
"field": "active",
"type": "boolean",
"description": "Active specifies if user is active or not."
},
{
"field": "displayName",
"type": "string",
"description": "DisplayName for the user."
},
{
"field": "emails",
"type": "array",
"description": "Emails for the user whether primary or secondary."
},
{
"field": "externalId",
"type": "string",
"description": "ExternalId specifies the ID for the user object in external system."
},
{
"field": "groups",
"type": "array",
"description": "Groups to which user is part of."
},
{
"field": "id",
"type": "string",
"description": "ID for user object."
},
{
"field": "meta",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "object",
"description": ""
},
{
"field": "nickName",
"type": "string",
"description": "NickName for the user."
},
{
"field": "roles",
"type": "array",
"description": "Roles defined for the user."
},
{
"field": "schemas",
"type": "array",
"description": "Schemas for user object as per scim spec 2.0."
},
{
"field": "userName",
"type": "string",
"description": "UserName for the user."
},
{
"field": "userType",
"type": "object",
"description": ""
}
]
}
]
},
	"scroll": {
"name": "scroll",
"displayName": "Scroll",
"operations": [
{
"name": "list_scroll",
"description": "Access Log Scroll Query.",
      "method": "GET",
"path": "/api/data/namespaces/{namespace}/access_logs/scroll",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "scroll_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
},
{
"name": "create_scroll",
"description": "Access Log Scroll Query.",
      "method": "POST",
"path": "/api/data/namespaces/{namespace}/access_logs/scroll",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse\ncontaining no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or\nall log messages, one can use the LogScrollRequest. Use the scroll_id returned in the LogResponse to fetch the next\nbatch of log messages and one can continue this process till the scroll_id returned in the LogResponse is \"\" which\nindicates no more log messages to scroll.",
"title": "LogScrollRequest",
"x-displayname": "Log Scroll Request.",
"x-ves-proto-message": "ves.io.schema.log.LogScrollRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Fetch the log messages scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
"title": "scroll id",
"x-displayname": "Scroll ID",
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for...",
"x-f5xc-description-medium": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or all log messages, one can use the LogScrollRequest. Use the scroll_id returned...",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logLogScrollRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logLogScrollRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logLogScrollRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Fetch the log messages scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"search-loadbalancers": {
"name": "search-loadbalancers",
"displayName": "Search Loadbalancers",
"operations": [
{
"name": "create_search_loadbalancer",
"description": "Search load balancers.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/search/loadbalancers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET a list of virtual hosts in all the namespaces matching filter provided in the request.\nThe filter can be a) Request ID b) Source IP.",
"title": "SearchLoadBalancersRequest",
"x-displayname": "Search Load Balancers Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SearchLoadBalancersRequest",
"properties": {
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" `Op` \"value\".\nResponse will only contain data that matches all the conditions specified in the `label_filter`.\nOne or more of the following labels can be specified in the label_filter.\n`REQUEST_ID`, `SOURCE_IP``.",
"title": "Label Filter",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/app_securitySearchFilter"
},
"x-displayname": "Label Filter.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "5"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "5"
},
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" \"value\". Response will only contain data that matches all the conditions specified in the .",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" \"value\". Response will only contain data that matches all the conditions specified in the . One or more of the following labels can be specified in the label_filter. , `.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "GET a list of virtual hosts in all the namespaces matching filter provided in the request.",
"x-f5xc-description-medium": "GET a list of virtual hosts in all the namespaces matching filter provided in the request. The filter can be a) Request ID b) Source IP.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySearchLoadBalancersRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySearchLoadBalancersRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"loadbalancers": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySearchLoadBalancersRequest"
},
"fieldMetadata": {
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" `Op` \"value\".\nResponse will only contain data that matches all the conditions specified in the `label_filter`.\nOne or more of the following labels can be specified in the label_filter.\n`REQUEST_ID`, `SOURCE_IP``.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "loadbalancers",
"type": "array",
"description": "HTTP load balancer list for which the SearchFilter is applied."
}
]
}
]
},
	"secret-management": {
"name": "secret-management",
      "displayName": "Secret Management",
      "operations": [
{
"name": "create_secret_management",
      "description": "Create Secret Policy Rule.",
      "method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy_rules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of secret_policy_rule",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.secret_policy_rule.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/schemasecret_policy_ruleCreateSpecType"
      }
],
"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 secret_policy_ruleCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_policy_ruleCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for secret_policy_ruleCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create secret_policy_rule creates a new object in storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds\nforward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to the originator. If\nit matches a rule with a NEXT_POLICY_SET action, evaluation of the current policy set terminates and evaluation of the next policy set in the chain begins.\n\n- DENY: DENY\n\nDeny the request.\n- ALLOW: ALLOW\n\nAllow the request to proceed.\n- NEXT_POLICY_SET: NEXT_POLICY_SET\n\nTerminate evaluation of the current policy set and begin evaluating the next policy set in the chain. Note that the evaluation of any remaining policies\nin the current policy set is skipped.\n- NEXT_POLICY: NEXT_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the next policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- LAST_POLICY: LAST_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the last policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- GOTO_POLICY: GOTO_POLICY\n\nTerminate evaluation of the current policy and begin evaluating a specific policy in the policy set. The policy is specified using the goto_policy field in\nthe rule and must be after the current policy in the policy set.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.client_name": {
"type": "string",
"description": "Exclusive with [client_name_matcher client_selector]\nThe name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate.\nThis predicate evaluates to true if client name matches the configured name.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.client_choice": [
"client_name",
"client_name_matcher",
"client_selector"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_secret_management",
      "description": "Replace Secret Policy Rule.",
      "method": "PUT",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy_rules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a secret_policy_rule",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.secret_policy_rule.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/schemasecret_policy_ruleReplaceSpecType"
      }
],
"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 secret_policy_ruleReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_policy_ruleReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for secret_policy_ruleReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace secret_policy_rule creates a new object in storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds\nforward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to the originator. If\nit matches a rule with a NEXT_POLICY_SET action, evaluation of the current policy set terminates and evaluation of the next policy set in the chain begins.\n\n- DENY: DENY\n\nDeny the request.\n- ALLOW: ALLOW\n\nAllow the request to proceed.\n- NEXT_POLICY_SET: NEXT_POLICY_SET\n\nTerminate evaluation of the current policy set and begin evaluating the next policy set in the chain. Note that the evaluation of any remaining policies\nin the current policy set is skipped.\n- NEXT_POLICY: NEXT_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the next policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- LAST_POLICY: LAST_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the last policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- GOTO_POLICY: GOTO_POLICY\n\nTerminate evaluation of the current policy and begin evaluating a specific policy in the policy set. The policy is specified using the goto_policy field in\nthe rule and must be after the current policy in the policy set.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.client_name": {
"type": "string",
"description": "Exclusive with [client_name_matcher client_selector]\nThe name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate.\nThis predicate evaluates to true if client name matches the configured name.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.client_choice": [
"client_name",
"client_name_matcher",
"client_selector"
]
}
},
{
"name": "list_secret_management",
      "description": "List Secret Policy Rule.",
      "method": "GET",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy_rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_secret_management",
      "description": "DELETE Secret Policy Rule.",
      "method": "DELETE",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy_rules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a secret_policy_rule",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.secret_policy_rule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for secret_policy_ruleDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_policy_ruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
}
},
{
"name": "get_secret_management",
      "description": "GET Secret Policy Rule.",
      "method": "GET",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy_rules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"secret-management-access-count": {
"name": "secret-management-access-count",
      "displayName": "Secret Management Access Count",
      "operations": [
{
"name": "create_secret_management_access_count",
      "description": "VoltShare Access Count Query.",
      "method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/voltshare/access_count",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
      "title": "VoltShareAccessCountRequest",
      "x-displayname": "VoltShare Access Count Request.",
      "x-ves-proto-message": "ves.io.schema.voltshare.VoltShareAccessCountRequest",
      "properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one or more labels listed here.\nOPERATION, RESULT, USER_TENANT, COUNTRY.\n\nOptional: If not specified, then the metric is aggregated across all the labels.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/metricsVoltShareMetricLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY.",
"x-f5xc-description-medium": "Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY. Optional: If not specified, then the metric is aggregated across all the labels.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nOPERATION, RESULT, USER_TENANT, COUNTRY.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"title": "Label Filter",
"items": {
"$ref": "#/components/schemas/metricsVoltShareMetricLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the security events for the given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app-namespace-1.",
"x-f5xc-example": "blogging-app-namespace-1",
"x-f5xc-description-short": "Namespace is used to scope the security events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "15m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "15m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
      "x-f5xc-description-medium": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltshareVoltShareAccessCountRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltshareVoltShareAccessCountRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for voltshareVoltShareAccessCountRequest"
      },
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by one or more labels listed here.\nOPERATION, RESULT, USER_TENANT, COUNTRY.\n\nOptional: If not specified, then the metric is aggregated across all the labels.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label\" Op \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\nOne or more of the following labels can be specified in the label_filter.\nOPERATION, RESULT, USER_TENANT, COUNTRY.\n\nOptional: If not specified, then the metrics will be filtered only based on the namespace in the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the security events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "List of VoltShare Access count data for each unique combination of group_by labels."
      },
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"secret-management-accesss": {
"name": "secret-management-accesss",
      "displayName": "Secret Management Accesss",
      "operations": [
{
"name": "create_secret_management_acce",
      "description": "Create Secret Management Access.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/secret_management_accesss",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of secret_management_access",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.secret_management_access.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/secret_management_accessCreateSpecType"
      }
],
"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 secret_management_accessCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_management_accessCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for secret_management_accessCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create secret_management_access creates a new object in storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info": {
      "type": "object",
"description": "HostAccessInfoType contains the information about how to connect to the remote host.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info.rest_auth_info": {
      "type": "object",
"description": "Authentication parameters for REST based hosts.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info.scheme": {
      "type": "string",
"description": "SchemeType is used to indicate URL scheme\n\nHTTP:// scheme\nHTTPS:// scheme.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "HTTP"
},
"spec.access_info.server_endpoint": {
      "type": "string",
"description": "Endpoint to connect to, in host:port format.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.access_info.tls_config": {
      "type": "object",
"description": "TLS configuration for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info.vault_auth_info": {
      "type": "object",
"description": "Authentication parameters for Hashicorp Vault hosts.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.provider_name": {
"type": "string",
"description": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.access_info.auth_params": [
      "rest_auth_info",
      "vault_auth_info"
      ],
"spec.access_info.rest_auth_info.auth_params": [
      "basic_auth",
      "headers_auth",
      "query_params_auth"
      ],
"spec.access_info.tls_config.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.access_info.tls_config.sni_choice": [
      "disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.access_info.tls_config.tls_params_choice": [
      "cert_params",
"common_params"
],
"spec.access_info.vault_auth_info.auth_params": [
      "app_role_auth",
      "token"
      ],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_secret_management_acce",
      "description": "Replace Secret Management Access.",
      "method": "PUT",
"path": "/api/config/namespaces/{namespace}/secret_management_accesss/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a secret_management_access",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.secret_management_access.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/secret_management_accessReplaceSpecType"
      }
],
"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 secret_management_accessReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_management_accessReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for secret_management_accessReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace secret_management_access replaces an existing object in storage backend for metadata.namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info": {
      "type": "object",
"description": "HostAccessInfoType contains the information about how to connect to the remote host.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info.rest_auth_info": {
      "type": "object",
"description": "Authentication parameters for REST based hosts.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info.scheme": {
      "type": "string",
"description": "SchemeType is used to indicate URL scheme\n\nHTTP:// scheme\nHTTPS:// scheme.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "HTTP"
},
"spec.access_info.server_endpoint": {
      "type": "string",
"description": "Endpoint to connect to, in host:port format.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.access_info.tls_config": {
      "type": "object",
"description": "TLS configuration for upstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.access_info.vault_auth_info": {
      "type": "object",
"description": "Authentication parameters for Hashicorp Vault hosts.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.provider_name": {
"type": "string",
"description": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.where": {
"type": "object",
"description": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site\nIt is used to determine virtual network using following rules\n* Direct reference to virtual_network object\n* Site local network when referring to site object\n* All site local networks for sites selected by referring to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.site": {
"type": "object",
"description": "This specifies a direct reference to a site configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_network": {
"type": "object",
"description": "This specifies a direct reference to a network configuration object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.where.virtual_site": {
"type": "object",
"description": "A reference to virtual_site object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.access_info.auth_params": [
      "rest_auth_info",
      "vault_auth_info"
      ],
"spec.access_info.rest_auth_info.auth_params": [
      "basic_auth",
      "headers_auth",
      "query_params_auth"
      ],
"spec.access_info.tls_config.max_session_keys_type": [
      "default_session_key_caching",
      "disable_session_key_caching",
      "max_session_keys"
      ],
"spec.access_info.tls_config.sni_choice": [
      "disable_sni",
"sni",
"use_host_header_as_sni"
],
"spec.access_info.tls_config.tls_params_choice": [
      "cert_params",
"common_params"
],
"spec.access_info.vault_auth_info.auth_params": [
      "app_role_auth",
      "token"
      ],
"spec.where.ref_or_selector": [
"site",
"virtual_network",
"virtual_site"
],
"spec.where.site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
],
"spec.where.virtual_site.internet_vip_choice": [
"disable_internet_vip",
"enable_internet_vip"
]
}
},
{
"name": "list_secret_management_accesss",
      "description": "List Secret Management Access.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/secret_management_accesss",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_secret_management_acce",
      "description": "DELETE Secret Management Access.",
      "method": "DELETE",
"path": "/api/config/namespaces/{namespace}/secret_management_accesss/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a secret_management_access",
      "x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.secret_management_access.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for secret_management_accessDeleteRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_management_accessDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
}
},
{
"name": "get_secret_management_acce",
      "description": "GET Secret Management Access.",
      "method": "GET",
"path": "/api/config/namespaces/{namespace}/secret_management_accesss/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"secret-management-audit-logs": {
"name": "secret-management-audit-logs",
      "displayName": "Secret Management Audit Logs",
      "operations": [
{
"name": "create_secret_management_audit_log",
      "description": "Audit Log Query.",
"method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch voltshare audit logs.",
"title": "AuditLogRequest",
"x-displayname": "Audit Log Request.",
"x-ves-proto-message": "ves.io.schema.voltshare.AuditLogRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are keyed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "0",
"x-f5xc-example": "0",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch the log messages scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_ip - source IP address\nsecret_name - secret name\nauthor_tenant - tenant name of the secret creator\noperation - Encrypt/Decrypt\nresult - Success/Fail\ncountry - Country name\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the audit logs matching the given tenant will be returned.",
      "title": "query",
"x-displayname": "Query",
"x-ves-example": "{user=\\\"dana@example.com\\\"}",
"x-f5xc-example": "\"{user=\\\"dana@example.com\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_ip - source IP address secret_name - secret...",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/voltshareSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltshareAuditLogRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltshareAuditLogRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for voltshareAuditLogRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch the log messages scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_ip - source IP address\nsecret_name - secret name\nauthor_tenant - tenant name of the secret creator\noperation - Encrypt/Decrypt\nresult - Success/Fail\ncountry - Country name\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the audit logs matching the given tenant will be returned.",
      "constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the AuditLogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"secret-management-audit-logs-aggregation": {
"name": "secret-management-audit-logs-aggregation",
      "displayName": "Secret Management Audit Logs Aggregation",
      "operations": [
{
"name": "create_secret_management_audit_logs_aggregation",
      "description": "Audit Log Aggregation Query.",
"method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for audit logs.",
"title": "AuditLogAggregationRequest",
"x-displayname": "Audit Log Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.voltshare.AuditLogAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are keyed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch aggregation data scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch aggregation data scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_ip - source IP address\nsecret_name - secret name\nauthor_tenant - tenant name of the secret creator\noperation - Encrypt/Decrypt\nresult - Success/Fail\ncountry - Country name\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the audit logs matching the given tenant will be considered for aggregation.",
      "title": "query",
"x-displayname": "Query",
"x-ves-example": "{user=\\\"dana@example.com\\\"}",
"x-f5xc-example": "\"{user=\\\"dana@example.com\\\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_ip - source IP address secret_name - secret...",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for audit logs.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltshareAuditLogAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltshareAuditLogAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for voltshareAuditLogAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch aggregation data scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_ip - source IP address\nsecret_name - secret name\nauthor_tenant - tenant name of the secret creator\noperation - Encrypt/Decrypt\nresult - Success/Fail\ncountry - Country name\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the audit logs matching the given tenant will be considered for aggregation.",
      "constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"secret-management-audit-logs-scroll": {
"name": "secret-management-audit-logs-scroll",
      "displayName": "Secret Management Audit Logs Scroll",
      "operations": [
{
"name": "list_secret_management_audit_logs_scroll",
      "description": "Audit Log Scroll Query.",
"method": "GET",
"path": "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/scroll",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "scroll_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the AuditLogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
},
{
"name": "create_secret_management_audit_logs_scroll",
      "description": "Audit Log Scroll Query.",
"method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/scroll",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse\ncontaining no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or\nall log messages, one can use the LogScrollRequest. Use the scroll_id returned in the LogResponse to fetch the next\nbatch of log messages and one can continue this process till the scroll_id returned in the LogResponse is \"\" which\nindicates no more log messages to scroll.",
"title": "AuditLogScrollRequest",
"x-displayname": "Audit Log Scroll Request.",
"x-ves-proto-message": "ves.io.schema.voltshare.AuditLogScrollRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Fetch the log messages scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
"title": "scroll id",
"x-displayname": "Scroll ID",
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for...",
"x-f5xc-description-medium": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or all log messages, one can use the LogScrollRequest. Use the scroll_id returned...",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltshareAuditLogScrollRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltshareAuditLogScrollRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for voltshareAuditLogScrollRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Fetch the log messages scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the AuditLogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"secret-management-get-policy-document": {
"name": "secret-management-get-policy-document",
      "displayName": "Secret Management Get Policy Document",
      "operations": [
{
"name": "list_secret_management_get_policy_document",
      "description": "Policy Document.",
"method": "GET",
"path": "/api/secret_management/namespaces/{namespace}/secret_policys/{name}/get_policy_document",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
}
]
}
]
},
	"secret-management-get-public-key": {
"name": "secret-management-get-public-key",
      "displayName": "Secret Management Get Public Key",
      "operations": [
{
"name": "list_secret_management_get_public_key",
      "description": "Public Key.",
      "method": "GET",
"path": "/api/secret_management/get_public_key",
      "dangerLevel": "low",
"parameters": [
{
"name": "key_version",
      "in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
}
]
}
]
},
	"secret-management-list-policy": {
"name": "secret-management-list-policy",
      "displayName": "Secret Management List Policy",
      "operations": [
{
"name": "get_secret_management_list_policy",
      "description": "List secret policy.",
      "method": "GET",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy/list_policy/{policy_state}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "policy_state",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
}
]
},
	"secret-management-recover": {
"name": "secret-management-recover",
      "displayName": "Secret Management Recover",
      "operations": [
{
"name": "create_secret_management_recover",
      "description": "Recover secret policy with given policy name.",
      "method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy/{name}/recover",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'RecoverPolicy' RPC.",
"title": "RecoverRequest is used to recover a secret_policy",
      "x-displayname": "Recover Request.",
"x-ves-proto-message": "ves.io.schema.secret_policy.RecoverRequest",
      "properties": {
"name": {
"type": "string",
"description": "Name of the secret policy.",
      "title": "name",
"x-displayname": "Name",
"x-ves-example": "Site-secret-policy.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "site-secret-policy",
      "x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the secret policy.",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Input message of the 'RecoverPolicy' RPC.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for secret_policyRecoverRequest",
      "required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_policyRecoverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for secret_policyRecoverRequest"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the secret policy.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the secret policy.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"secret-management-softdelete": {
"name": "secret-management-softdelete",
      "displayName": "Secret Management Softdelete",
      "operations": [
{
"name": "create_secret_management_softdelete",
      "description": "DELETE secret policy with given policy name.",
      "method": "POST",
"path": "/api/secret_management/namespaces/{namespace}/secret_policy/{name}/softdelete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DeletePolicy' RPC.",
"title": "SoftDeleteRequest is used to soft delete a secret_policy",
      "x-displayname": "Soft DELETE Request.",
"x-ves-proto-message": "ves.io.schema.secret_policy.SoftDeleteRequest",
      "properties": {
"name": {
"type": "string",
"description": "Name of the secret policy.",
      "title": "name",
"x-displayname": "Name",
"x-ves-example": "Site-secret-policy.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "site-secret-policy",
      "x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the secret policy.",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Input message of the 'DeletePolicy' RPC.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for secret_policySoftDeleteRequest",
      "required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for secret_policySoftDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for secret_policySoftDeleteRequest"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the secret policy.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the secret policy.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"secret-management-voltshare-decrypt-secret": {
"name": "secret-management-voltshare-decrypt-secret",
      "displayName": "Secret Management Voltshare Decrypt Secret",
      "operations": [
{
"name": "create_secret_management_voltshare_decrypt_secret",
      "description": "DecryptSecret.",
      "method": "POST",
"path": "/api/secret_management/namespaces/system/voltshare/decrypt_secret",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "DecryptSecretRequest contains parameters for DecryptSecret API.",
      "title": "DecryptSecret Request",
      "x-displayname": "DecryptSecret Request.",
      "x-ves-proto-message": "ves.io.schema.voltshare.DecryptSecretRequest",
      "properties": {
"blinded_encrypted_key_base64": {
      "type": "string",
"description": "Blinded Encrypted Key in base64 format.",
      "title": "blinded_encrypted_key",
      "x-displayname": "Blinded Encrypted Key.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"policy_document": {
"allOf": [
{
"$ref": "#/components/schemas/voltsharePolicyInformationType"
}
],
"x-f5xc-description-short": "Configuration parameter for policy document.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document_hmac_base64": {
"type": "string",
"description": "Base64 encoded HMAC of the policy document.",
"title": "policy_document_hmac",
"x-displayname": "Policy Document HMAC.",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Base64 encoded HMAC of the policy document.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "DecryptSecretRequest contains parameters for DecryptSecret API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltshareDecryptSecretRequest",
      "required_fields": [
"blinded_encrypted_key_base64",
      "policy_document_hmac_base64"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltshareDecryptSecretRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  blinded_encrypted_key_base64: value\n  policy_document_hmac_base64: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"blinded_encrypted_key_base64\": \"value\",\n    \"policy_document_hmac_base64\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"blinded_key_base64": {
      "type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"blinded_encrypted_key_base64": "value",
      "policy_document_hmac_base64": "value"
}
},
"requiredFields": [
"blinded_encrypted_key_base64",
      "policy_document_hmac_base64"
],
"description": "Minimum configuration for voltshareDecryptSecretRequest"
      },
"fieldMetadata": {
"blinded_encrypted_key_base64": {
      "type": "string",
"description": "Blinded Encrypted Key in base64 format.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"policy_document": {
"type": "object",
"description": "PolicyInformation contains user defined policy and metadata added by the backend server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.author": {
      "type": "object",
"description": "UserRecordType contains information about a user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.author.email": {
      "type": "string",
"description": "Email ID of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 256,
"min": 1
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"policy_document.author.tenant": {
      "type": "string",
"description": "Tenant of the user.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"byteLength": {
"max": 256,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"policy_document.blindfold_key_version": {
      "type": "integer",
"description": "Version of BlindfoldKey that will be used for encryption.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.creation_time": {
"type": "string",
"description": "Creation time for this policy document.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.policy": {
"type": "object",
"description": "Policy contains user defined policy. It contains list of allowed users and expiry time.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.policy.allowed_users": {
"type": "array",
"description": "List of Users allowed to decrypt the secret.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.policy.expiration_timestamp": {
"type": "string",
"description": "Until when this policy is valid. After expiration only author can decrypt the secret.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.policy_id": {
"type": "string",
"description": "A unique 31 bit number assigned to this policy.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "uint64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document.secret_name": {
      "type": "string",
"description": "Name of the secret.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_document_hmac_base64": {
"type": "string",
"description": "Base64 encoded HMAC of the policy document.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "blinded_key_base64",
      "type": "string",
"description": "Blinded Key in base64 format."
      }
]
}
]
},
	"secret-management-voltshare-process-policy-information": {
"name": "secret-management-voltshare-process-policy-information",
      "displayName": "Secret Management Voltshare Process Policy Information",
      "operations": [
{
"name": "create_secret_management_voltshare_process_policy_information",
      "description": "ProcessPolicyInformation.",
"method": "POST",
"path": "/api/secret_management/namespaces/system/voltshare/process_policy_information",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "ProcessPolicyRequest contains parameters ProcessPolicyInformation API.",
      "title": "ProcessPolicyRequest",
"x-displayname": "ProcessPolicy Request.",
"x-ves-proto-message": "ves.io.schema.voltshare.ProcessPolicyRequest",
"properties": {
"policy": {
"allOf": [
{
"$ref": "#/components/schemas/voltsharePolicyType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"secret_name": {
      "type": "string",
"description": "Name of the secret.",
      "title": "secret_name",
      "minLength": 1,
"maxLength": 256,
"x-displayname": "Secret Name.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "256",
"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.max_bytes": "256",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"byteLength": {
"max": 256,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "ProcessPolicyRequest contains parameters ProcessPolicyInformation API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltshareProcessPolicyRequest",
"required_fields": [
"secret_name"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltshareProcessPolicyRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  secret_name: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"secret_name\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "blindfold"
},
"responseSchema": {
"type": "object",
"properties": {
"policy_document_hmac_base64": {
"type": "string"
},
"public_key": {
      "type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"secret_name": "value"
      }
},
"requiredFields": [
"secret_name"
      ],
"description": "Minimum configuration for voltshareProcessPolicyRequest"
},
"fieldMetadata": {
"policy": {
"type": "object",
"description": "Policy contains user defined policy. It contains list of allowed users and expiry time.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy.allowed_users": {
"type": "array",
"description": "List of Users allowed to decrypt the secret.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy.expiration_timestamp": {
"type": "string",
"description": "Until when this policy is valid. After expiration only author can decrypt the secret.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"secret_name": {
      "type": "string",
"description": "Name of the secret.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"byteLength": {
"max": 256,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "policy_document",
"type": "object",
"description": ""
},
{
"field": "policy_document_hmac_base64",
"type": "string",
"description": "Base64 encoded HMAC of the policy document."
},
{
"field": "public_key",
      "type": "string",
"description": "PublicKey Document contains information about PublicKey used to encrypt symmetric encryption key. Private part of this key is ONLY with F5XC Secret Management service.\nValue of this field is a base64 string. When decoded, it unmarshal to PublicKeyDocumentType structure."
      }
]
}
]
},
	"securemesh-site-v2s": {
"name": "securemesh-site-v2s",
"displayName": "Securemesh Site V2S",
"operations": [
{
"name": "create_securemesh_site_v2",
"description": "Create Secure Mesh site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/securemesh_site_v2s",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of securemesh_site_v2",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.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/viewssecuremesh_site_v2CreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Secure Mesh Site v2 for multi-cloud CE deployments (Azure, AWS, GCP, bare-metal, etc.)",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "provider_choice",
"fields": [
"spec.aws",
"spec.azure",
"spec.baremetal",
"spec.equinix",
"spec.gcp",
"spec.kvm",
"spec.nutanix",
"spec.oci",
"spec.openshift_virtualization",
"spec.openstack",
"spec.vmware"
],
"required": true,
"reason": "Choose exactly one cloud provider"
},
{
"name": "node_ha_choice",
"fields": [
"spec.disable_ha",
"spec.enable_ha"
],
"reason": "HA enabled or disabled"
},
{
"name": "blocked_services_choice",
"fields": [
"spec.block_all_services",
"spec.blocked_services"
],
"reason": "Block all or specific services"
},
{
"name": "network_policy_choice",
"fields": [
"spec.active_enhanced_firewall_policies",
"spec.no_network_policy"
],
"reason": "Network policy or none"
},
{
"name": "forward_proxy_choice",
"fields": [
"spec.active_forward_proxy_policies",
"spec.no_forward_proxy"
],
"reason": "Forward proxy or none"
},
{
"name": "enterprise_proxy_choice",
"fields": [
"spec.custom_proxy",
"spec.f5_proxy"
],
"reason": "Proxy type"
},
{
"name": "proxy_bypass_choice",
"fields": [
"spec.custom_proxy_bypass",
"spec.no_proxy_bypass"
],
"reason": "Proxy bypass or none"
},
{
"name": "logs_receiver_choice",
"fields": [
"spec.log_receiver_with_net",
"spec.logs_streaming_disabled"
],
"reason": "Log receiver or disabled"
},
{
"name": "s2s_connectivity_sli_choice",
"fields": [
"spec.dc_cluster_group_sli",
"spec.no_s2s_connectivity_sli"
],
"reason": "S2S connectivity SLI"
},
{
"name": "s2s_connectivity_slo_choice",
"fields": [
"spec.dc_cluster_group_slo",
"spec.no_s2s_connectivity_slo",
"spec.site_mesh_group_on_slo"
],
"reason": "S2S connectivity SLO"
},
{
"name": "url_categorization_choice",
"fields": [
"spec.disable_url_categorization",
"spec.enable_url_categorization"
],
"reason": "URL categorization"
},
{
"name": "management_network_choice",
"fields": [
"spec.disable_management_network",
"spec.enable_management_network"
],
"reason": "Management network"
}
],
"example_yaml": "metadata:\n  name: example-smsv2\n  namespace: system\nspec:\n  azure:\n    not_managed:\n      node_list: []\n  disable_ha: {}\n  no_network_policy: {}\n  no_forward_proxy: {}\n  logs_streaming_disabled: {}\n  block_all_services: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-smsv2\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"azure\": {\n      \"not_managed\": {\n        \"node_list\": []\n      }\n    },\n    \"disable_ha\": {},\n    \"no_network_policy\": {},\n    \"no_forward_proxy\": {},\n    \"logs_streaming_disabled\": {},\n    \"block_all_services\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-smsv2",
"namespace": "system"
},
"spec": {
"azure": {
"not_managed": {
"node_list": []
}
},
"disable_ha": {},
"no_network_policy": {},
"no_forward_proxy": {},
"logs_streaming_disabled": {},
"block_all_services": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Secure Mesh Site v2 for multi-cloud CE deployments (Azure, AWS, GCP, bare-metal, etc.)"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Secure Mesh site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies.enhanced_firewall_policies": {
"type": "array",
"description": "Ordered List of Enhanced Firewall Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies.forward_proxy_policies": {
"type": "array",
"description": "Ordered List of Forward Proxy Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.admin_user_credentials": {
      "type": "object",
"description": "Setup user credentials to manage access to nodes belonging to the site.\nWhen configured, 'admin' user will be setup and customers can access these nodes via\neither the node local WebUI or via SSH to access shell/CLI\nEnsure 'Node Local Services' are enabled to allow for required access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_user_credentials.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_user_credentials.ssh_key": {
      "type": "string",
"description": "Provided Public SSH key can be used for accessing nodes of the site.\nWhen provided, customers can SSH to the nodes of this Customer Edge site using admin as the user.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws": {
"type": "object",
"description": "AWS Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure": {
"type": "object",
"description": "Azure Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.baremetal": {
"type": "object",
"description": "Baremetal Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.baremetal.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.custom_proxy": {
"type": "object",
"description": "Custom Enterprise Proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.disable_re_tunnel": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.enable_re_tunnel": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.proxy_ip_address": {
"type": "string",
"description": "Specify the IPv4 Address of the internal Enterprise Proxy.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_proxy.proxy_port": {
"type": "integer",
"description": "Specify the Port of the internal Enterprise Proxy.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_proxy.username": {
"type": "string",
"description": "If the internal Enterprise Proxy is using basic authentication, specify the username. This is an optional field.",
      "constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy_bypass": {
"type": "object",
"description": "List of domains to bypass the proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy_bypass.proxy_bypass": {
"type": "array",
"description": "List of domains to bypass the proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_advanced_delivery": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ha": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_management_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_url_categorization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config": {
"type": "object",
"description": "Specify DNS and NTP servers that will be used by the nodes in this Customer Edge site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.custom_dns": {
"type": "object",
"description": "DNS Servers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.custom_ntp": {
"type": "object",
"description": "NTP Servers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.f5_dns_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.f5_ntp_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_advanced_delivery": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ha": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_management_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_url_categorization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.equinix": {
"type": "object",
"description": "Equinix Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.equinix.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp": {
"type": "object",
"description": "GCP Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kvm": {
"type": "object",
"description": "KVM Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kvm.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.load_balancing": {
"type": "object",
"description": "This section contains settings on the site that relate to Load Balancing functionality.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.load_balancing.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.local_vrf": {
"type": "object",
"description": "There can be two local VRFs on each site.\nThe Site Local Outside (SLO) local VRF is used to connect WAN side workloads to this site and to connect the site to F5 Distributed Cloud for management. All sites are required to have an SLO local VRF.\nThe Site Local Inside (SLI) local VRF is used to connect LAN side workloads to this site. SLI local VRF is optional.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.default_sli_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.sli_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.slo_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net": {
"type": "object",
"description": "Select log receiver for logs streaming with network option.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net.use_management_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net.use_slo_sli": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_proxy_bypass": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_s2s_connectivity_sli": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_s2s_connectivity_slo": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nutanix": {
"type": "object",
"description": "Nutanix Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nutanix.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oci": {
"type": "object",
"description": "OCI Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oci.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openshift_virtualization": {
"type": "object",
"description": "OpenShift Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openshift_virtualization.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openstack": {
"type": "object",
"description": "Openstack Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openstack.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_select": {
"type": "object",
"description": "Selection criteria to connect the site with F5 Distributed Cloud Regional Edge(s).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_select.geo_proximity": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_select.specific_re": {
"type": "object",
"description": "Select specific REs. This is useful when a site needs to deterministically connect to a set of REs. A site will always be connected to 2 REs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_vrf": {
"type": "array",
"description": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid\nper Site that can be configured here.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo": {
"type": "object",
"description": "Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.no_site_mesh_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.site_mesh_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.software_settings": {
"type": "object",
"description": "Select OS and Software version for the site. All nodes in the site will run the same OS and Software version. These settings cannot be changed after the site is created.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.software_settings.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.software_settings.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_type": {
"type": "string",
"description": "Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL.\nTunnel is of type IPsec\nTunnel is of type SSL.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL"
},
"spec.upgrade_settings": {
"type": "object",
"description": "Specify how a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upgrade_settings.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vmware": {
"type": "object",
"description": "VMware Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vmware.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advanced_delivery_choice": [
"disable_advanced_delivery",
"enable_advanced_delivery"
],
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services"
],
"spec.enterprise_proxy_choice": [
"custom_proxy",
"f5_proxy"
],
"spec.forward_proxy_choice": [
"active_forward_proxy_policies",
"no_forward_proxy"
],
"spec.log_anonymization_choice": [
"disable_log_anonymization",
"enable_log_anonymization"
],
"spec.logs_receiver_choice": [
"log_receiver_with_net",
"logs_streaming_disabled"
],
"spec.management_network_choice": [
"disable_management_network",
"enable_management_network"
],
"spec.network_policy_choice": [
"active_enhanced_firewall_policies",
"no_network_policy"
],
"spec.node_ha_choice": [
"disable_ha",
"enable_ha"
],
"spec.provider_choice": [
"aws",
"azure",
"baremetal",
"equinix",
"gcp",
"kvm",
"nutanix",
"oci",
"openshift_virtualization",
"openstack",
"vmware"
],
"spec.proxy_bypass_choice": [
"custom_proxy_bypass",
"no_proxy_bypass"
],
"spec.s2s_connectivity_sli_choice": [
"dc_cluster_group_sli",
"no_s2s_connectivity_sli"
],
"spec.s2s_connectivity_slo_choice": [
"dc_cluster_group_slo",
"no_s2s_connectivity_slo",
"site_mesh_group_on_slo"
],
"spec.url_categorization_choice": [
"disable_url_categorization",
"enable_url_categorization"
],
"spec.admin_user_credentials.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.aws.orchestration_choice": [
"not_managed"
],
"spec.azure.orchestration_choice": [
"not_managed"
],
"spec.baremetal.orchestration_choice": [
"not_managed"
],
"spec.custom_proxy.use_for_re_tunnel_choice": [
"disable_re_tunnel",
"enable_re_tunnel"
],
"spec.custom_proxy.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.dns_ntp_config.dns_server_choice": [
"custom_dns",
"f5_dns_default"
],
"spec.dns_ntp_config.ntp_server_choice": [
"custom_ntp",
"f5_ntp_default"
],
"spec.equinix.orchestration_choice": [
"not_managed"
],
"spec.gcp.orchestration_choice": [
"not_managed"
],
"spec.kvm.orchestration_choice": [
"not_managed"
],
"spec.local_vrf.sli_choice": [
"default_sli_config",
"sli_config"
],
"spec.local_vrf.slo_choice": [
"default_config",
"slo_config"
],
"spec.local_vrf.sli_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.local_vrf.sli_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.local_vrf.slo_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.local_vrf.slo_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.log_receiver_with_net.network_choice": [
"use_management_network",
"use_slo_sli"
],
"spec.nutanix.orchestration_choice": [
"not_managed"
],
"spec.oci.orchestration_choice": [
"not_managed"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.openshift_virtualization.orchestration_choice": [
"not_managed"
],
"spec.openstack.orchestration_choice": [
"not_managed"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
],
"spec.re_select.re_selection_choice": [
"geo_proximity",
"specific_re"
],
"spec.site_mesh_group_on_slo.site_mesh_group_choice": [
"no_site_mesh_group",
"site_mesh_group"
],
"spec.site_mesh_group_on_slo.site_mesh_group_ip_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.software_settings.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.software_settings.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
],
"spec.upgrade_settings.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.vmware.orchestration_choice": [
"not_managed"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_securemesh_site_v2",
"description": "Replace Secure Mesh site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a securemesh_site_v2",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewssecuremesh_site_v2ReplaceSpecType"
}
],
"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": "Secure Mesh Site v2 for multi-cloud CE deployments (Azure, AWS, GCP, bare-metal, etc.)",
"required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "provider_choice",
"fields": [
"spec.aws",
"spec.azure",
"spec.baremetal",
"spec.equinix",
"spec.gcp",
"spec.kvm",
"spec.nutanix",
"spec.oci",
"spec.openshift_virtualization",
"spec.openstack",
"spec.vmware"
],
"required": true,
"reason": "Choose exactly one cloud provider"
},
{
"name": "node_ha_choice",
"fields": [
"spec.disable_ha",
"spec.enable_ha"
],
"reason": "HA enabled or disabled"
},
{
"name": "blocked_services_choice",
"fields": [
"spec.block_all_services",
"spec.blocked_services"
],
"reason": "Block all or specific services"
},
{
"name": "network_policy_choice",
"fields": [
"spec.active_enhanced_firewall_policies",
"spec.no_network_policy"
],
"reason": "Network policy or none"
},
{
"name": "forward_proxy_choice",
"fields": [
"spec.active_forward_proxy_policies",
"spec.no_forward_proxy"
],
"reason": "Forward proxy or none"
},
{
"name": "enterprise_proxy_choice",
"fields": [
"spec.custom_proxy",
"spec.f5_proxy"
],
"reason": "Proxy type"
},
{
"name": "proxy_bypass_choice",
"fields": [
"spec.custom_proxy_bypass",
"spec.no_proxy_bypass"
],
"reason": "Proxy bypass or none"
},
{
"name": "logs_receiver_choice",
"fields": [
"spec.log_receiver_with_net",
"spec.logs_streaming_disabled"
],
"reason": "Log receiver or disabled"
},
{
"name": "s2s_connectivity_sli_choice",
"fields": [
"spec.dc_cluster_group_sli",
"spec.no_s2s_connectivity_sli"
],
"reason": "S2S connectivity SLI"
},
{
"name": "s2s_connectivity_slo_choice",
"fields": [
"spec.dc_cluster_group_slo",
"spec.no_s2s_connectivity_slo",
"spec.site_mesh_group_on_slo"
],
"reason": "S2S connectivity SLO"
},
{
"name": "url_categorization_choice",
"fields": [
"spec.disable_url_categorization",
"spec.enable_url_categorization"
],
"reason": "URL categorization"
},
{
"name": "management_network_choice",
"fields": [
"spec.disable_management_network",
"spec.enable_management_network"
],
"reason": "Management network"
}
],
"example_yaml": "metadata:\n  name: example-smsv2\n  namespace: system\nspec:\n  azure:\n    not_managed:\n      node_list: []\n  disable_ha: {}\n  no_network_policy: {}\n  no_forward_proxy: {}\n  logs_streaming_disabled: {}\n  block_all_services: {}\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-smsv2\",\n    \"namespace\": \"system\"\n  },\n  \"spec\": {\n    \"azure\": {\n      \"not_managed\": {\n        \"node_list\": []\n      }\n    },\n    \"disable_ha\": {},\n    \"no_network_policy\": {},\n    \"no_forward_proxy\": {},\n    \"logs_streaming_disabled\": {},\n    \"block_all_services\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-smsv2",
"namespace": "system"
},
"spec": {
"azure": {
"not_managed": {
"node_list": []
}
},
"disable_ha": {},
"no_network_policy": {},
"no_forward_proxy": {},
"logs_streaming_disabled": {},
"block_all_services": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Secure Mesh Site v2 for multi-cloud CE deployments (Azure, AWS, GCP, bare-metal, etc.)"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Secure Mesh site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_enhanced_firewall_policies.enhanced_firewall_policies": {
"type": "array",
"description": "Ordered List of Enhanced Firewall Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_forward_proxy_policies.forward_proxy_policies": {
"type": "array",
"description": "Ordered List of Forward Proxy Policies active.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.admin_user_credentials": {
      "type": "object",
"description": "Setup user credentials to manage access to nodes belonging to the site.\nWhen configured, 'admin' user will be setup and customers can access these nodes via\neither the node local WebUI or via SSH to access shell/CLI\nEnsure 'Node Local Services' are enabled to allow for required access.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_user_credentials.admin_password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.admin_user_credentials.ssh_key": {
      "type": "string",
"description": "Provided Public SSH key can be used for accessing nodes of the site.\nWhen provided, customers can SSH to the nodes of this Customer Edge site using admin as the user.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8192,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws": {
"type": "object",
"description": "AWS Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.aws.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure": {
"type": "object",
"description": "Azure Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.azure.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.baremetal": {
"type": "object",
"description": "Baremetal Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.baremetal.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.block_all_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.custom_proxy": {
"type": "object",
"description": "Custom Enterprise Proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.disable_re_tunnel": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.enable_re_tunnel": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.password": {
      "type": "object",
"description": "SecretType is used in an object to indicate a sensitive/confidential field.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy.proxy_ip_address": {
"type": "string",
"description": "Specify the IPv4 Address of the internal Enterprise Proxy.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_proxy.proxy_port": {
"type": "integer",
"description": "Specify the Port of the internal Enterprise Proxy.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.custom_proxy.username": {
"type": "string",
"description": "If the internal Enterprise Proxy is using basic authentication, specify the username. This is an optional field.",
      "constraints": {
"constraintType": "string",
"category": "identity",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_.-]+$",
"characterSet": {
"allowed": "[a-zA-Z0-9_.-]",
"description": "Alphanumeric with underscores, dots, hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy_bypass": {
"type": "object",
"description": "List of domains to bypass the proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_proxy_bypass.proxy_bypass": {
"type": "array",
"description": "List of domains to bypass the proxy.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_sli.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dc_cluster_group_slo.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_advanced_delivery": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_ha": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_url_categorization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config": {
"type": "object",
"description": "Specify DNS and NTP servers that will be used by the nodes in this Customer Edge site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.custom_dns": {
"type": "object",
"description": "DNS Servers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.custom_ntp": {
"type": "object",
"description": "NTP Servers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.f5_dns_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_ntp_config.f5_ntp_default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_advanced_delivery": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_ha": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_log_anonymization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_url_categorization": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.equinix": {
"type": "object",
"description": "Equinix Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.equinix.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.f5_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp": {
"type": "object",
"description": "GCP Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.gcp.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kvm": {
"type": "object",
"description": "KVM Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kvm.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.load_balancing": {
"type": "object",
"description": "This section contains settings on the site that relate to Load Balancing functionality.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.load_balancing.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.local_vrf": {
"type": "object",
"description": "There can be two local VRFs on each site.\nThe Site Local Outside (SLO) local VRF is used to connect WAN side workloads to this site and to connect the site to F5 Distributed Cloud for management. All sites are required to have an SLO local VRF.\nThe Site Local Inside (SLI) local VRF is used to connect LAN side workloads to this site. SLI local VRF is optional.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.default_sli_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.sli_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_vrf.slo_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net": {
"type": "object",
"description": "Select log receiver for logs streaming with network option.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net.use_management_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver_with_net.use_slo_sli": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_proxy_bypass": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_s2s_connectivity_sli": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_s2s_connectivity_slo": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nutanix": {
"type": "object",
"description": "Nutanix Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.nutanix.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oci": {
"type": "object",
"description": "OCI Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.oci.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openshift_virtualization": {
"type": "object",
"description": "OpenShift Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openshift_virtualization.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openstack": {
"type": "object",
"description": "Openstack Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.openstack.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_select": {
"type": "object",
"description": "Selection criteria to connect the site with F5 Distributed Cloud Regional Edge(s).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_select.geo_proximity": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.re_select.specific_re": {
"type": "object",
"description": "Select specific REs. This is useful when a site needs to deterministically connect to a set of REs. A site will always be connected to 2 REs.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_vrf": {
"type": "array",
"description": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid\nper Site that can be configured here.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo": {
"type": "object",
"description": "Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.no_site_mesh_group": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.site_mesh_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_mesh_group_on_slo.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.software_settings": {
"type": "object",
"description": "Select OS and Software version for the site. All nodes in the site will run the same OS and Software version. These settings cannot be changed after the site is created.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.software_settings.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.software_settings.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_type": {
"type": "string",
"description": "Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL.\nTunnel is of type IPsec\nTunnel is of type SSL.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL"
},
"spec.upgrade_settings": {
"type": "object",
"description": "Specify how a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.upgrade_settings.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vmware": {
"type": "object",
"description": "VMware Provider Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vmware.not_managed": {
"type": "object",
"description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advanced_delivery_choice": [
"disable_advanced_delivery",
"enable_advanced_delivery"
],
"spec.blocked_services_choice": [
"block_all_services",
"blocked_services"
],
"spec.enterprise_proxy_choice": [
"custom_proxy",
"f5_proxy"
],
"spec.forward_proxy_choice": [
"active_forward_proxy_policies",
"no_forward_proxy"
],
"spec.log_anonymization_choice": [
"disable_log_anonymization",
"enable_log_anonymization"
],
"spec.logs_receiver_choice": [
"log_receiver_with_net",
"logs_streaming_disabled"
],
"spec.network_policy_choice": [
"active_enhanced_firewall_policies",
"no_network_policy"
],
"spec.node_ha_choice": [
"disable_ha",
"enable_ha"
],
"spec.provider_choice": [
"aws",
"azure",
"baremetal",
"equinix",
"gcp",
"kvm",
"nutanix",
"oci",
"openshift_virtualization",
"openstack",
"vmware"
],
"spec.proxy_bypass_choice": [
"custom_proxy_bypass",
"no_proxy_bypass"
],
"spec.s2s_connectivity_sli_choice": [
"dc_cluster_group_sli",
"no_s2s_connectivity_sli"
],
"spec.s2s_connectivity_slo_choice": [
"dc_cluster_group_slo",
"no_s2s_connectivity_slo",
"site_mesh_group_on_slo"
],
"spec.url_categorization_choice": [
"disable_url_categorization",
"enable_url_categorization"
],
"spec.admin_user_credentials.admin_password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.aws.orchestration_choice": [
"not_managed"
],
"spec.azure.orchestration_choice": [
"not_managed"
],
"spec.baremetal.orchestration_choice": [
"not_managed"
],
"spec.custom_proxy.use_for_re_tunnel_choice": [
"disable_re_tunnel",
"enable_re_tunnel"
],
"spec.custom_proxy.password.secret_info_oneof": [
      "blindfold_secret_info",
      "clear_secret_info"
      ],
"spec.dns_ntp_config.dns_server_choice": [
"custom_dns",
"f5_dns_default"
],
"spec.dns_ntp_config.ntp_server_choice": [
"custom_ntp",
"f5_ntp_default"
],
"spec.equinix.orchestration_choice": [
"not_managed"
],
"spec.gcp.orchestration_choice": [
"not_managed"
],
"spec.kvm.orchestration_choice": [
"not_managed"
],
"spec.local_vrf.sli_choice": [
"default_sli_config",
"sli_config"
],
"spec.local_vrf.slo_choice": [
"default_config",
"slo_config"
],
"spec.local_vrf.sli_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.local_vrf.sli_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.local_vrf.slo_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.local_vrf.slo_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.log_receiver_with_net.network_choice": [
"use_management_network",
"use_slo_sli"
],
"spec.nutanix.orchestration_choice": [
"not_managed"
],
"spec.oci.orchestration_choice": [
"not_managed"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.openshift_virtualization.orchestration_choice": [
"not_managed"
],
"spec.openstack.orchestration_choice": [
"not_managed"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
],
"spec.re_select.re_selection_choice": [
"geo_proximity",
"specific_re"
],
"spec.site_mesh_group_on_slo.site_mesh_group_choice": [
"no_site_mesh_group",
"site_mesh_group"
],
"spec.site_mesh_group_on_slo.site_mesh_group_ip_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.software_settings.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.software_settings.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
],
"spec.upgrade_settings.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.vmware.orchestration_choice": [
"not_managed"
]
}
},
{
"name": "list_securemesh_site_v2s",
"description": "List Configure Secure Mesh Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/securemesh_site_v2s",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_securemesh_site_v2",
"description": "DELETE Configure Secure Mesh Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a securemesh_site_v2",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for securemesh_site_v2DeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for securemesh_site_v2DeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
}
},
{
"name": "get_securemesh_site_v2",
"description": "GET Secure Mesh site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"securemesh-sites": {
"name": "securemesh-sites",
"displayName": "Securemesh Sites",
"operations": [
{
"name": "create_securemesh_site",
"description": "Create Secure Mesh site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/securemesh_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of securemesh_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.securemesh_site.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/viewssecuremesh_siteCreateSpecType"
}
],
"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 securemesh_siteCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for securemesh_siteCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for securemesh_siteCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Secure Mesh site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.bond_device_list": {
"type": "object",
"description": "List of bond devices for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list.bond_devices": {
"type": "array",
"description": "List of bond devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_interface_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_sli_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.interface_list": {
"type": "object",
"description": "Configure network interfaces for this Secure Mesh site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sli_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.slo_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_network_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.master_node_configuration": {
"type": "array",
"description": "Configuration of master nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_bond_devices": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.volterra_certified_hw": {
"type": "string",
"description": "Name for generic server certified hardware to form this Secure Mesh site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.worker_nodes": {
"type": "array",
"description": "Names of worker nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"blocked_services",
"default_blocked_services"
],
"spec.bond_choice": [
"bond_device_list",
"no_bond_devices"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.network_cfg_choice": [
"custom_network_config",
"default_network_config"
],
"spec.custom_network_config.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.custom_network_config.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.custom_network_config.interface_choice": [
"default_interface_config",
"interface_list"
],
"spec.custom_network_config.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.custom_network_config.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.custom_network_config.sli_choice": [
"default_sli_config",
"sli_config"
],
"spec.custom_network_config.slo_choice": [
"default_config",
"slo_config"
],
"spec.custom_network_config.sli_config.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.custom_network_config.sli_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.sli_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.custom_network_config.slo_config.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.custom_network_config.slo_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.slo_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_securemesh_site",
"description": "Replace Secure Mesh site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/securemesh_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a securemesh_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.securemesh_site.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/viewssecuremesh_siteReplaceSpecType"
}
],
"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 securemesh_siteReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for securemesh_siteReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for securemesh_siteReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Secure Mesh site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.bond_device_list": {
"type": "object",
"description": "List of bond devices for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list.bond_devices": {
"type": "array",
"description": "List of bond devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_interface_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_sli_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.interface_list": {
"type": "object",
"description": "Configure network interfaces for this Secure Mesh site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sli_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.slo_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_network_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.master_node_configuration": {
"type": "array",
"description": "Configuration of master nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_bond_devices": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode": {
"type": "object",
"description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l3_enhanced": {
"type": "object",
"description": "L3 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.performance_enhancement_mode.perf_mode_l7_enhanced": {
"type": "object",
"description": "L7 enhanced performance mode OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.volterra_certified_hw": {
"type": "string",
"description": "Name for generic server certified hardware to form this Secure Mesh site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.worker_nodes": {
"type": "array",
"description": "Names of worker nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"blocked_services",
"default_blocked_services"
],
"spec.bond_choice": [
"bond_device_list",
"no_bond_devices"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.network_cfg_choice": [
"custom_network_config",
"default_network_config"
],
"spec.custom_network_config.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.custom_network_config.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.custom_network_config.interface_choice": [
"default_interface_config",
"interface_list"
],
"spec.custom_network_config.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.custom_network_config.site_mesh_group_choice": [
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.custom_network_config.sli_choice": [
"default_sli_config",
"sli_config"
],
"spec.custom_network_config.slo_choice": [
"default_config",
"slo_config"
],
"spec.custom_network_config.sli_config.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.custom_network_config.sli_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.sli_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.custom_network_config.slo_config.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.custom_network_config.slo_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.slo_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.performance_enhancement_mode.perf_mode_choice": [
"perf_mode_l3_enhanced",
"perf_mode_l7_enhanced"
],
"spec.performance_enhancement_mode.perf_mode_l3_enhanced.perf_mode_choice": [
"jumbo",
"no_jumbo"
],
"spec.performance_enhancement_mode.perf_mode_l7_enhanced.perf_mode_choice": [
"jumbo_disabled",
"jumbo_enabled"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
}
},
{
"name": "list_securemesh_sites",
"description": "List Configure Secure Mesh Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/securemesh_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_securemesh_site",
"description": "DELETE Configure Secure Mesh Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/securemesh_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a securemesh_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.securemesh_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for securemesh_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for securemesh_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
}
},
{
"name": "get_securemesh_site",
"description": "GET Secure Mesh site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/securemesh_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"segment-connections": {
"name": "segment-connections",
"displayName": "Segment Connections",
"operations": [
{
"name": "replace_segment_connection",
"description": "Replace segment connector.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/segment_connections/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a segment_connection",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.segment_connection.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/segment_connectionReplaceSpecType"
}
],
"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 segment_connectionReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for segment_connectionReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for segment_connectionReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the segment connector specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connections": {
"type": "array",
"description": "Configure a Segment Connector to allow network traffic between Segments.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_segment_connections",
"description": "List Segment Connector.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/segment_connections",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_segment_connection",
"description": "GET segment connector.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/segment_connections/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"segments": {
"name": "segments",
"displayName": "Segments",
"operations": [
{
"name": "create_segment",
"description": "Create segment.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/segments",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of segment",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.segment.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/schemasegmentCreateSpecType"
}
],
"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 segmentCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for segmentCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for segmentCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the segment specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.internet_connection_choice": [
"disable",
"enable"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_segment",
"description": "Replace segment.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/segments/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a segment",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.segment.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/schemasegmentReplaceSpecType"
}
],
"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 segmentReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for segmentReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for segmentReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the segment specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.internet_connection_choice": [
"disable",
"enable"
]
}
},
{
"name": "list_segments",
"description": "List Segment.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/segments",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_segment",
"description": "DELETE Segment.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/segments/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a segment",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.segment.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for segmentDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for segmentDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_segment",
"description": "GET segment.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/segments/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"selectees": {
"name": "selectees",
"displayName": "Selectees",
"operations": [
{
"name": "list_selectees",
"description": "GET Selectees.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_sites/{name}/selectees",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "error",
"type": "object",
"description": ""
},
{
"field": "items",
"type": "array",
"description": "List of selected objects."
}
]
}
]
},
	"sensitive-data-policys": {
"name": "sensitive-data-policys",
"displayName": "Sensitive Data Policys",
"operations": [
{
"name": "create_sensitive_data_policy",
"description": "Create Sensitive Data Discovery.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/sensitive_data_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of sensitive_data_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.sensitive_data_policy.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/schemasensitive_data_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Sensitive data policy for PII detection and masking in API responses",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: sensitive_data_policy\nmetadata:\n  name: example-sensitive-data\n  namespace: default\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-sensitive-data\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-sensitive-data",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Sensitive data policy for PII detection and masking in API responses"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create sensitive_data_policy creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compliances": {
"type": "array",
"description": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 17,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_data_types": {
"type": "array",
"description": "Select your custom data types to be monitored in the API discovery.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disabled_predefined_data_types": {
"type": "array",
"description": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_sensitive_data_policy",
"description": "Replace Sensitive Data Discovery.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/sensitive_data_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a sensitive_data_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.sensitive_data_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemasensitive_data_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Sensitive data policy for PII detection and masking in API responses",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: sensitive_data_policy\nmetadata:\n  name: example-sensitive-data\n  namespace: default\nspec: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-sensitive-data\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}\n"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-sensitive-data",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Sensitive data policy for PII detection and masking in API responses"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compliances": {
"type": "array",
"description": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 17,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_data_types": {
"type": "array",
"description": "Select your custom data types to be monitored in the API discovery.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disabled_predefined_data_types": {
"type": "array",
"description": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_sensitive_data_policys",
"description": "List Sensitive Data Discovery.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sensitive_data_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_sensitive_data_policy",
"description": "DELETE Sensitive Data Discovery.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/sensitive_data_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a sensitive_data_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.sensitive_data_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for sensitive_data_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for sensitive_data_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
}
},
{
"name": "get_sensitive_data_policy",
"description": "GET Sensitive Data Discovery.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sensitive_data_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"service": {
"name": "service",
"displayName": "Service",
"operations": [
{
"name": "create_service",
"description": "Service Graph Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/service",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Graph/service API is used to GET service mesh graph of related services.",
      "title": "Service Graph Request",
"x-displayname": "Service Graph Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.Request",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/serviceFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of namespace, site, service, app_type and vhost.\n\nOptional: If not specified, then the data is aggregated/grouped by namespace and service.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/serviceIdField"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by any or all of namespace, site, service, app_type and vhost.",
"x-f5xc-description-medium": "Aggregate data by any or all of namespace, site, service, app_type and vhost. Optional: If not specified, then the data is aggregated/grouped by namespace and service.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"format": "boolean",
"x-displayname": "Trend calculation requested by the user.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid\naggregation across all app_types for the given namespace.",
      "title": "Label Filter",
"items": {
"$ref": "#/components/schemas/serviceLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid aggregation across all...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Graph/service API is used to GET service mesh graph of related services.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for serviceRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "FieldSelector is used to specify the list of fields to be returned in the response for site graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.api_endpoint": {
      "type": "object",
"description": "Selector for API Endpoints.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of namespace, site, service, app_type and vhost.\n\nOptional: If not specified, then the data is aggregated/grouped by namespace and service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"is_trend_request": {
"type": "boolean",
"description": "Trend value computation requested by the user\nOptional: default is false.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid\naggregation across all app_types for the given namespace.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"service-app-types": {
"name": "service-app-types",
"displayName": "Service App Types",
"operations": [
{
"name": "list_service_app_types",
"description": "Application Types.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/graph/service/app_types",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "App Type data for a given namespace."
}
]
}
]
},
	"service-credentials": {
"name": "service-credentials",
      "displayName": "Service Credentials",
      "operations": [
{
"name": "create_service_credential",
      "description": "Activate API service credential.",
      "method": "POST",
"path": "/api/web/namespaces/{namespace}/activate/service_credentials",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "GET credential object with a given name.",
      "title": "Get credential request",
      "x-displayname": "GET Credential.",
      "x-ves-proto-message": "ves.io.schema.api_credential.GetRequest",
      "properties": {
"name": {
"type": "string",
"description": "Name of API credential.",
      "title": "Credential name",
      "x-displayname": "Name",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "GET credential object with a given name.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_credentialGetRequest",
      "required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_credentialGetRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for api_credentialGetRequest"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of API credential.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Value of namespace is always \"system\".",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "boolean",
"description": "Result status flag."
}
]
},
{
"name": "list_service_credentials",
      "description": "List service credentials.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/service_credentials",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of service credential items."
      }
]
},
{
"name": "get_service_credential",
      "description": "GET Service Credential.",
      "method": "GET",
"path": "/api/web/namespaces/{namespace}/service_credentials/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"create_timestamp": {
"type": "string"
},
"expiry_timestamp": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"uid": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_group_names": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "active",
"type": "boolean",
"description": "Possibility to deactivate credential with no deletion."
      },
{
"field": "create_timestamp",
"type": "string",
"description": "Create time of service credential."
      },
{
"field": "expiry_timestamp",
"type": "string",
"description": "Expiry time of service credential."
      },
{
"field": "name",
"type": "string",
"description": "Name of service credential object."
      },
{
"field": "namespace",
"type": "string",
"description": "Namespace of service credential object."
      },
{
"field": "namespace_access",
      "type": "object",
"description": ""
},
{
"field": "type",
"type": "object",
"description": ""
},
{
"field": "uid",
"type": "string",
"description": "Uid of service credential object."
      },
{
"field": "user_email",
"type": "string",
"description": "Email of the service user attached to service credential ."
      },
{
"field": "user_group_names",
"type": "array",
"description": "User group list associated to this service credential."
      }
]
},
{
"name": "replace_service_credential",
      "description": "Replace service credentials.",
      "method": "PUT",
"path": "/api/web/namespaces/{namespace}/service_credentials/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request format for replacing service credentials.",
      "title": "Replace Service Credentials Request",
      "x-displayname": "Replace Service Credentials Request.",
      "x-ves-proto-message": "ves.io.schema.api_credential.ReplaceServiceCredentialsRequest",
      "properties": {
"name": {
"type": "string",
"description": "Name of service credential object.",
      "title": "Service Credential name",
      "x-displayname": "Name",
"x-ves-example": "API-cred-00000000-0000-4000-8000-c725f8541661.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "api-cred-00000000-0000-4000-8000-c725f8541661",
      "x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the service credential user.\nValue of namespace is always \"system\".",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace of the service credential user. Value of namespace is always \"system\".",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace_access": {
      "allOf": [
{
"$ref": "#/components/schemas/schemaNamespaceAccessType"
      }
],
"x-f5xc-example": "example-resource",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_group_names": {
"type": "array",
"description": "List of user_groups to be replaced for this service credentials.",
      "title": "User Groups Names",
"items": {
"type": "string"
},
"x-displayname": "Groups",
"x-ves-example": "[\"dev-group-1\"]",
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
"x-f5xc-description-short": "List of user_groups to be replaced for this service credentials.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request format for replacing service credentials.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_credentialReplaceServiceCredentialsRequest",
      "required_fields": [
"name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_credentialReplaceServiceCredentialsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"expiration_timestamp": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value"
}
},
"requiredFields": [
"name"
],
"description": "Minimum configuration for api_credentialReplaceServiceCredentialsRequest"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of service credential object.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the service credential user.\nValue of namespace is always \"system\".",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_access": {
      "type": "object",
"description": "Access info in the namespaces for the entity.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace_access.namespace_role_map": {
      "type": "object",
"description": "List of all the roles for the entity in the namespaces.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"user_group_names": {
"type": "array",
"description": "List of user_groups to be replaced for this service credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "active",
"type": "boolean",
"description": "Specifies if service credential is active or not."
      },
{
"field": "expiration_timestamp",
"type": "string",
"description": "Specifies the expiration timestamp."
},
{
"field": "name",
"type": "string",
"description": "Name of API credential record."
      }
]
}
]
},
	"service-edge": {
"name": "service-edge",
"displayName": "Service Edge",
"operations": [
{
"name": "create_service_edge",
"description": "Service Edge Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/service/edge",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "While graph/service API is used to GET the service mesh for an app_type,\nwhere each node and edge contains the aggregated value for each field;\ngraph/service/edge API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.",
      "title": "Service Edge Request",
"x-displayname": "Service Edge Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.EdgeRequest",
"properties": {
"dst_id": {
"allOf": [
{
"$ref": "#/components/schemas/serviceServiceRequestId"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/serviceEdgeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id": {
"allOf": [
{
"$ref": "#/components/schemas/serviceServiceRequestId"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "While graph/service API is used to GET the service mesh for an app_type, where each node and edge contains the aggregated value for each field...",
      "x-f5xc-description-medium": "While graph/service API is used to GET the service mesh for an app_type, where each node and edge contains the aggregated value for each field; graph/service/edge API is used to GET the time-series data (drill-down of aggregated data) for each field.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceEdgeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceEdgeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for serviceEdgeRequest"
},
"fieldMetadata": {
"dst_id": {
"type": "object",
"description": "Service request ID to fetch metric for a specific service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.app_type": {
"type": "string",
"description": "Application type associated with the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.service": {
"type": "string",
"description": "Network name or name of the virtual service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"dst_id.site": {
"type": "string",
"description": "Site name where the service is running. If the service is deployed\nin multiple sites, only the metric from this site will be returned\nin the response.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.vip": {
"type": "string",
"description": "VIP associated with the Virtual Host.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.virtual_host": {
"type": "string",
"description": "Virtual host associated with the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.api_endpoint": {
      "type": "object",
"description": "Selector for API Endpoints.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.types": {
"type": "array",
"description": "Specify list of metrics that should be returned for each edge in the connectivity graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id": {
"type": "object",
"description": "Service request ID to fetch metric for a specific service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.app_type": {
"type": "string",
"description": "Application type associated with the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.service": {
"type": "string",
"description": "Network name or name of the virtual service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"src_id.site": {
"type": "string",
"description": "Site name where the service is running. If the service is deployed\nin multiple sites, only the metric from this site will be returned\nin the response.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.vip": {
"type": "string",
"description": "VIP associated with the Virtual Host.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.virtual_host": {
"type": "string",
"description": "Virtual host associated with the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"service-node": {
"name": "service-node",
"displayName": "Service Node",
"operations": [
{
"name": "create_service_node",
"description": "Service Node Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/service/node",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET time-series data for a node in the service graph.\nWhile graph/service API is used to GET the service mesh for an app_type,\nwhere each node and edge contains the aggregated value for each field;\ngraph/service/node API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.",
      "title": "Service Node Request",
"x-displayname": "Service Node Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.NodeRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/serviceNodeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/serviceServiceRequestId"
}
],
"x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET time-series data for a node in the service graph.",
"x-f5xc-description-medium": "Request to GET time-series data for a node in the service graph. While graph/service API is used to GET the service mesh for an app_type, where each node and edge contains the aggregated value for each field; graph/service/node API is used to GET the time-series data (drill-down of aggregated...",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceNodeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceNodeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for serviceNodeRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.downstream": {
"type": "array",
"description": "Downstream refers to the service that sends requests and receives response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.upstream": {
"type": "array",
"description": "Upstream refers to the service that receives requests and sends response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "object",
"description": "Service request ID to fetch metric for a specific service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.app_type": {
"type": "string",
"description": "Application type associated with the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.service": {
"type": "string",
"description": "Network name or name of the virtual service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id.site": {
"type": "string",
"description": "Site name where the service is running. If the service is deployed\nin multiple sites, only the metric from this site will be returned\nin the response.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.vip": {
"type": "string",
"description": "VIP associated with the Virtual Host.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.virtual_host": {
"type": "string",
"description": "Virtual host associated with the service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"service-node-instance": {
"name": "service-node-instance",
"displayName": "Service Node Instance",
"operations": [
{
"name": "create_service_node_instance",
"description": "Service Instance Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/service/node/instance",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the time-series data for an instance in the service node.",
"title": "Service Instance Request",
"x-displayname": "Service Instance Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.InstanceRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/serviceNodeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/instanceInstanceRequestId"
}
],
"x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope application traffic to a given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the time-series data for an instance in the service node.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceInstanceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceInstanceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for serviceInstanceRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.downstream": {
"type": "array",
"description": "Downstream refers to the service that sends requests and receives response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.upstream": {
"type": "array",
"description": "Upstream refers to the service that receives requests and sends response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "object",
"description": "Instance request ID to fetch metric from a specific service instance.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.app_type": {
"type": "string",
"description": "Application type associated with the service instance.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id.instance": {
"type": "string",
"description": "Name of the service instance.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id.service": {
"type": "string",
"description": "Network name or name of the virtual service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"id.site": {
"type": "string",
"description": "Site name where the service instance is running.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.virtual_host": {
"type": "string",
"description": "Virtual host associated with the service instance.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"service-node-instances": {
"name": "service-node-instances",
"displayName": "Service Node Instances",
"operations": [
{
"name": "create_service_node_instance_service_node_instances",
"description": "Service Instances Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/service/node/instances",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET instances data for a node in the service graph.",
"title": "Service Instances Request",
"x-displayname": "Service Instances Request.",
"x-ves-proto-message": "ves.io.schema.graph.service.InstancesRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/serviceNodeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST\n\nOptional: If not specified, then the data is aggregated/grouped by all fields.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/instanceInstanceIdField"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST Optional: If not specified, then the data is...",
"x-f5xc-description-medium": "Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST Optional: If not specified, then the data is aggregated/grouped by all fields.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: To GET the instances for an (app_type, service), user should specify LABEL_APP_TYPE and\nLABEL_SERVICE in the label_filter.",
      "title": "Label Filter",
"items": {
"$ref": "#/components/schemas/serviceLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: To GET the instances for an (app_type, service), user should specify LABEL_APP_TYPE and LABEL_SERVICE in the...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope application traffic to a given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET instances data for a node in the service graph.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for serviceInstancesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for serviceInstancesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for serviceInstancesRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.downstream": {
"type": "array",
"description": "Downstream refers to the service that sends requests and receives response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.upstream": {
"type": "array",
"description": "Upstream refers to the service that receives requests and sends response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST\n\nOptional: If not specified, then the data is aggregated/grouped by all fields.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: To GET the instances for an (app_type, service), user should specify LABEL_APP_TYPE and\nLABEL_SERVICE in the label_filter.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope application traffic to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"service-policy-rules": {
"name": "service-policy-rules",
"displayName": "Service Policy Rules",
"operations": [
{
"name": "create_service_policy_rule",
"description": "Create Service Policy Rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/service_policy_rules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of service_policy_rule",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.service_policy_rule.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/schemaservice_policy_ruleCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Service policy for network-level access control and traffic rules",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "rule_choice",
"fields": [
"spec.allow_all_requests",
"spec.deny_all_requests",
"spec.rule_list"
],
"reason": "Choose exactly one rule selection method (REQUIRED)"
},
{
"name": "server_choice",
"fields": [
"spec.any_server",
"spec.server_name",
"spec.server_selector",
"spec.server_name_matcher"
],
"reason": "Choose server scope (default: any_server)"
}
],
"example_yaml": "apiVersion: v1\nkind: service_policy\nmetadata:\n  name: allow-all\n  namespace: default\nspec:\n  allow_all_requests: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"allow-all\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"allow_all_requests\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "allow-all",
"namespace": "default"
},
"spec": {
"allow_all_requests": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Service policy for network-level access control and traffic rules"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create service_policy_rule creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds\nforward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to the originator. If\nit matches a rule with a NEXT_POLICY_SET action, evaluation of the current policy set terminates and evaluation of the next policy set in the chain begins.\n\n- DENY: DENY\n\nDeny the request.\n- ALLOW: ALLOW\n\nAllow the request to proceed.\n- NEXT_POLICY_SET: NEXT_POLICY_SET\n\nTerminate evaluation of the current policy set and begin evaluating the next policy set in the chain. Note that the evaluation of any remaining policies\nin the current policy set is skipped.\n- NEXT_POLICY: NEXT_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the next policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- LAST_POLICY: LAST_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the last policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- GOTO_POLICY: GOTO_POLICY\n\nTerminate evaluation of the current policy and begin evaluating a specific policy in the policy set. The policy is specified using the goto_policy field in\nthe rule and must be after the current policy in the policy set.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.any_asn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_client": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_group_matcher": {
      "type": "object",
"description": "A matcher specifies a list of values for matching an input string. The match is considered successful if the input value is present in the list. The result of\nthe match is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_group_matcher.invert_matcher": {
      "type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_group_matcher.match": {
      "type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.arg_matchers": {
"type": "array",
"description": "A list of predicates for all POST args that need to be matched. The criteria for matching each arg are described in individual instances\nof ArgMatcherType. The actual arg values are extracted from the request API as a list of strings for each arg selector name.\nNote that all specified arg matcher predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn_list.as_numbers": {
"type": "array",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.asn_matcher": {
"type": "object",
"description": "Match any AS number contained in the list of bgp_asn_sets.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn_matcher.asn_sets": {
"type": "array",
"description": "A list of references to bgp_asn_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.body_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.body_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.body_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.body_matcher.transformers": {
"type": "array",
"description": "An ordered list of transformers (starting from index 0) to be applied to the path before matching.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 9,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_action": {
"type": "object",
"description": "Modify Bot protection behavior for a matching request. The modification could be to entirely skip Bot processing.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_action.bot_skip_processing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_action.none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name": {
"type": "string",
"description": "Exclusive with [any_client client_name_matcher client_selector ip_threat_category_list]\nThe expected name of the client invoking the request API.\nThe predicate evaluates to true if any of the actual names is the same as the expected client name.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cookie_matchers": {
"type": "array",
"description": "A list of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances\nof CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name.\nNote that all specified cookie matcher predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.expiration_timestamp": {
"type": "string",
"description": "The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in\nthe configuration but is not applied anymore.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.headers": {
"type": "array",
"description": "A list of predicates for various HTTP headers that need to match. The criteria for matching each HTTP header are described in individual HeaderMatcherType\ninstances. The actual HTTP header values are extracted from the request API as a list of strings for each HTTP header type.\nNote that all specified header predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_method": {
"type": "object",
"description": "A HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list.\nThe result of the match based on the method list is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_method.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_method.methods": {
"type": "array",
"description": "List of methods values to match against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_matcher": {
"type": "object",
"description": "Match any IP prefix contained in the list of ip_prefix_sets.\nThe result of the match is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_matcher.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_matcher.prefix_sets": {
"type": "array",
"description": "A list of references to ip_prefix_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ip_prefix_list": {
"type": "object",
"description": "List of IP Prefix strings to match against.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_list.invert_match": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_list.ip_prefixes": {
"type": "array",
"description": "List of IPv4 prefix strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_threat_category_list": {
"type": "object",
"description": "List of IP threat categories.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_threat_category_list.ip_threat_categories": {
"type": "array",
"description": "The IP threat categories is obtained from the list and is used to auto-generate equivalent label selection expressions.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ja4_tls_fingerprint": {
"type": "object",
"description": "An extended version of JA3 that includes additional fields for more comprehensive fingerprinting of\nSSL/TLS clients and potentially has a different structure and length.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ja4_tls_fingerprint.exact_values": {
"type": "array",
"description": "A list of exact JA4 TLS fingerprint to match the input JA4 TLS fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_claims": {
"type": "array",
"description": "A list of predicates for various JWT claims that need to match. The criteria for matching each JWT claim are described in individual JWTClaimMatcherType\ninstances. The actual JWT claims values are extracted from the JWT payload as a list of strings.\nNote that all specified JWT claim predicates must evaluate to true.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher": {
"type": "object",
"description": "A label matcher specifies a list of label keys whose values need to match for\nsource/client and destination/server. Note that the actual label values are not\nspecified and do not matter. This allows an ability to scope grouping by the\nlabel key name.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher.keys": {
      "type": "array",
"description": "The list of label key names that have to match.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_rule_evaluation": {
"type": "boolean",
"description": "Log the rule match details along with the request and continue to evaluate rules in the sequence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mum_action": {
"type": "object",
"description": "Modify behavior for a matching request. The modification could be to entirely skip processing.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mum_action.default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mum_action.skip_processing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path": {
"type": "object",
"description": "A path matcher specifies multiple criteria for matching an HTTP path string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of path prefixes, a list of exact path values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.encoded_path_matcher": {
"type": "boolean",
"description": "Match against the encoded, escaped path.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.exact_values": {
"type": "array",
"description": "A list of exact path values to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.prefix_values": {
"type": "array",
"description": "A list of path prefix values to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.suffix_values": {
"type": "array",
"description": "A list of path suffix values to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.transformers": {
"type": "array",
"description": "An ordered list of transformers (starting from index 0) to be applied to the path before matching.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 9,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_matcher": {
"type": "object",
"description": "A port matcher specifies a list of port ranges as match criteria. The match is considered successful if the input port falls within any of the port ranges.\nThe result of the match is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_matcher.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_matcher.ports": {
"type": "array",
"description": "A list of strings, each of which is a single port value or a tuple of start and end port values separated by \"-\". The start and end values are considered\nto be part of the range.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.query_params": {
"type": "array",
"description": "A list of predicates for all query parameters that need to be matched. The criteria for matching each query parameter are described in individual instances\nof QueryParameterMatcherType. The actual query parameter values are extracted from the request API as a list of strings for each query parameter name.\nNote that all specified query parameter predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_count_exceeds": {
"type": "integer",
"description": "Exclusive with [max_cookie_count_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_count_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_key_size_exceeds": {
      "type": "integer",
"description": "Exclusive with [max_cookie_key_size_none]",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_key_size_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_value_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_cookie_value_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_value_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_count_exceeds": {
"type": "integer",
"description": "Exclusive with [max_header_count_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 40,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_count_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_key_size_exceeds": {
      "type": "integer",
"description": "Exclusive with [max_header_key_size_none]",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_key_size_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_value_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_header_value_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 64000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_value_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_count_exceeds": {
"type": "integer",
"description": "Exclusive with [max_parameter_count_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_count_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_name_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_parameter_name_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_name_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_value_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_parameter_value_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1073741824,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_value_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_query_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_query_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_query_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_line_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_request_line_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65536,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_line_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_request_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65536,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_url_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_url_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 128000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_url_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy": {
"type": "object",
"description": "Configure source and destination segment for policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.dst_any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.dst_segments": {
"type": "object",
"description": "List of references to Segments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.intra_segment": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.src_any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.src_segments": {
"type": "object",
"description": "List of references to Segments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher": {
"type": "object",
"description": "A TLS fingerprint matcher specifies multiple criteria for matching a TLS fingerprint. The set of supported positive match criteria includes a list of known\nclasses of TLS fingerprints and a list of exact values. The match is considered successful if either of these positive criteria are satisfied and the input\nfingerprint is not one of the excluded values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher.classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher.exact_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher.excluded_values": {
"type": "array",
"description": "A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one\nor more known TLS fingerprint classes in the enclosing matcher.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action": {
"type": "object",
"description": "Modify App Firewall behavior for a matching request. The modification could either be to entirely skip firewall processing or to customize the firewall rules\nto be applied as defined by App Firewall Rule Control settings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action.app_firewall_detection_control": {
"type": "object",
"description": "Define the list of Signature IDs, Violations, Attack Types and Bot Names that should be excluded from triggering on the defined match criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action.none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action.waf_skip_processing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.asn_choice": [
"any_asn",
"asn_list",
"asn_matcher"
],
"spec.client_choice": [
"any_client",
"client_name",
"client_name_matcher",
"client_selector",
"ip_threat_category_list"
],
"spec.dst_asn_choice": [],
"spec.dst_ip_choice": [],
"spec.ip_choice": [
"any_ip",
"ip_matcher",
"ip_prefix_list"
],
"spec.tls_fingerprint_choice": [
"ja4_tls_fingerprint",
"tls_fingerprint_matcher"
],
"spec.bot_action.action_type": [
"bot_skip_processing",
"none"
],
"spec.mum_action.action_type": [
"default",
"skip_processing"
],
"spec.request_constraints.max_cookie_count_choice": [
"max_cookie_count_exceeds",
"max_cookie_count_none"
],
"spec.request_constraints.max_cookie_key_size_choice": [
      "max_cookie_key_size_exceeds",
      "max_cookie_key_size_none"
      ],
"spec.request_constraints.max_cookie_value_size_choice": [
"max_cookie_value_size_exceeds",
"max_cookie_value_size_none"
],
"spec.request_constraints.max_header_count_choice": [
"max_header_count_exceeds",
"max_header_count_none"
],
"spec.request_constraints.max_header_key_size_choice": [
      "max_header_key_size_exceeds",
      "max_header_key_size_none"
      ],
"spec.request_constraints.max_header_value_size_choice": [
"max_header_value_size_exceeds",
"max_header_value_size_none"
],
"spec.request_constraints.max_parameter_count_choice": [
"max_parameter_count_exceeds",
"max_parameter_count_none"
],
"spec.request_constraints.max_parameter_name_size_choice": [
"max_parameter_name_size_exceeds",
"max_parameter_name_size_none"
],
"spec.request_constraints.max_parameter_value_size_choice": [
"max_parameter_value_size_exceeds",
"max_parameter_value_size_none"
],
"spec.request_constraints.max_query_size_choice": [
"max_query_size_exceeds",
"max_query_size_none"
],
"spec.request_constraints.max_request_line_size_choice": [
"max_request_line_size_exceeds",
"max_request_line_size_none"
],
"spec.request_constraints.max_request_size_choice": [
"max_request_size_exceeds",
"max_request_size_none"
],
"spec.request_constraints.max_url_size_choice": [
"max_url_size_exceeds",
"max_url_size_none"
],
"spec.segment_policy.dst_segment_choice": [
"dst_any",
"dst_segments",
"intra_segment"
],
"spec.segment_policy.src_segment_choice": [
"src_any",
"src_segments"
],
"spec.waf_action.action_type": [
"app_firewall_detection_control",
"none",
"waf_skip_processing"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_service_policy_rule",
"description": "Replace Service Policy Rule.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/service_policy_rules/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a service_policy_rule",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.service_policy_rule.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemaservice_policy_ruleReplaceSpecType"
}
],
"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": "Service policy for network-level access control and traffic rules",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "rule_choice",
"fields": [
"spec.allow_all_requests",
"spec.deny_all_requests",
"spec.rule_list"
],
"reason": "Choose exactly one rule selection method (REQUIRED)"
},
{
"name": "server_choice",
"fields": [
"spec.any_server",
"spec.server_name",
"spec.server_selector",
"spec.server_name_matcher"
],
"reason": "Choose server scope (default: any_server)"
}
],
"example_yaml": "apiVersion: v1\nkind: service_policy\nmetadata:\n  name: allow-all\n  namespace: default\nspec:\n  allow_all_requests: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"allow-all\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"allow_all_requests\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "allow-all",
"namespace": "default"
},
"spec": {
"allow_all_requests": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Service policy for network-level access control and traffic rules"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace service_policy_rule replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.action": {
"type": "string",
"description": "The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds\nforward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to the originator. If\nit matches a rule with a NEXT_POLICY_SET action, evaluation of the current policy set terminates and evaluation of the next policy set in the chain begins.\n\n- DENY: DENY\n\nDeny the request.\n- ALLOW: ALLOW\n\nAllow the request to proceed.\n- NEXT_POLICY_SET: NEXT_POLICY_SET\n\nTerminate evaluation of the current policy set and begin evaluating the next policy set in the chain. Note that the evaluation of any remaining policies\nin the current policy set is skipped.\n- NEXT_POLICY: NEXT_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the next policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- LAST_POLICY: LAST_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the last policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n- GOTO_POLICY: GOTO_POLICY\n\nTerminate evaluation of the current policy and begin evaluating a specific policy in the policy set. The policy is specified using the goto_policy field in\nthe rule and must be after the current policy in the policy set.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DENY"
},
"spec.any_asn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_client": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_group_matcher": {
      "type": "object",
"description": "A matcher specifies a list of values for matching an input string. The match is considered successful if the input value is present in the list. The result of\nthe match is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_group_matcher.invert_matcher": {
      "type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_group_matcher.match": {
      "type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.arg_matchers": {
"type": "array",
"description": "A list of predicates for all POST args that need to be matched. The criteria for matching each arg are described in individual instances\nof ArgMatcherType. The actual arg values are extracted from the request API as a list of strings for each arg selector name.\nNote that all specified arg matcher predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn_list.as_numbers": {
"type": "array",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.asn_matcher": {
"type": "object",
"description": "Match any AS number contained in the list of bgp_asn_sets.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.asn_matcher.asn_sets": {
"type": "array",
"description": "A list of references to bgp_asn_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.body_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.body_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.body_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.body_matcher.transformers": {
"type": "array",
"description": "An ordered list of transformers (starting from index 0) to be applied to the path before matching.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 9,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_action": {
"type": "object",
"description": "Modify Bot protection behavior for a matching request. The modification could be to entirely skip Bot processing.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_action.bot_skip_processing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bot_action.none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name": {
"type": "string",
"description": "Exclusive with [any_client client_name_matcher client_selector ip_threat_category_list]\nThe expected name of the client invoking the request API.\nThe predicate evaluates to true if any of the actual names is the same as the expected client name.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.client_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.cookie_matchers": {
"type": "array",
"description": "A list of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances\nof CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name.\nNote that all specified cookie matcher predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domain_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.expiration_timestamp": {
"type": "string",
"description": "The expiration_timestamp is the RFC 3339 format timestamp at which the containing rule is considered to be logically expired. The rule continues to exist in\nthe configuration but is not applied anymore.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.headers": {
"type": "array",
"description": "A list of predicates for various HTTP headers that need to match. The criteria for matching each HTTP header are described in individual HeaderMatcherType\ninstances. The actual HTTP header values are extracted from the request API as a list of strings for each HTTP header type.\nNote that all specified header predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_method": {
"type": "object",
"description": "A HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list.\nThe result of the match based on the method list is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_method.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_method.methods": {
"type": "array",
"description": "List of methods values to match against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_matcher": {
"type": "object",
"description": "Match any IP prefix contained in the list of ip_prefix_sets.\nThe result of the match is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_matcher.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_matcher.prefix_sets": {
"type": "array",
"description": "A list of references to ip_prefix_set objects.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ip_prefix_list": {
"type": "object",
"description": "List of IP Prefix strings to match against.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_list.invert_match": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_prefix_list.ip_prefixes": {
"type": "array",
"description": "List of IPv4 prefix strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_threat_category_list": {
"type": "object",
"description": "List of IP threat categories.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ip_threat_category_list.ip_threat_categories": {
"type": "array",
"description": "The IP threat categories is obtained from the list and is used to auto-generate equivalent label selection expressions.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.ja4_tls_fingerprint": {
"type": "object",
"description": "An extended version of JA3 that includes additional fields for more comprehensive fingerprinting of\nSSL/TLS clients and potentially has a different structure and length.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ja4_tls_fingerprint.exact_values": {
"type": "array",
"description": "A list of exact JA4 TLS fingerprint to match the input JA4 TLS fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jwt_claims": {
"type": "array",
"description": "A list of predicates for various JWT claims that need to match. The criteria for matching each JWT claim are described in individual JWTClaimMatcherType\ninstances. The actual JWT claims values are extracted from the JWT payload as a list of strings.\nNote that all specified JWT claim predicates must evaluate to true.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher": {
"type": "object",
"description": "A label matcher specifies a list of label keys whose values need to match for\nsource/client and destination/server. Note that the actual label values are not\nspecified and do not matter. This allows an ability to scope grouping by the\nlabel key name.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.label_matcher.keys": {
      "type": "array",
"description": "The list of label key names that have to match.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_rule_evaluation": {
"type": "boolean",
"description": "Log the rule match details along with the request and continue to evaluate rules in the sequence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mum_action": {
"type": "object",
"description": "Modify behavior for a matching request. The modification could be to entirely skip processing.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mum_action.default": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.mum_action.skip_processing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path": {
"type": "object",
"description": "A path matcher specifies multiple criteria for matching an HTTP path string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of path prefixes, a list of exact path values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.encoded_path_matcher": {
"type": "boolean",
"description": "Match against the encoded, escaped path.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.exact_values": {
"type": "array",
"description": "A list of exact path values to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.prefix_values": {
"type": "array",
"description": "A list of path prefix values to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.suffix_values": {
"type": "array",
"description": "A list of path suffix values to match the input HTTP path against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.path.transformers": {
"type": "array",
"description": "An ordered list of transformers (starting from index 0) to be applied to the path before matching.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 9,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_matcher": {
"type": "object",
"description": "A port matcher specifies a list of port ranges as match criteria. The match is considered successful if the input port falls within any of the port ranges.\nThe result of the match is inverted if invert_matcher is true.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_matcher.invert_matcher": {
"type": "boolean",
"description": "Invert the match result.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_matcher.ports": {
"type": "array",
"description": "A list of strings, each of which is a single port value or a tuple of start and end port values separated by \"-\". The start and end values are considered\nto be part of the range.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.query_params": {
"type": "array",
"description": "A list of predicates for all query parameters that need to be matched. The criteria for matching each query parameter are described in individual instances\nof QueryParameterMatcherType. The actual query parameter values are extracted from the request API as a list of strings for each query parameter name.\nNote that all specified query parameter predicates must evaluate to true.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_count_exceeds": {
"type": "integer",
"description": "Exclusive with [max_cookie_count_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_count_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_key_size_exceeds": {
      "type": "integer",
"description": "Exclusive with [max_cookie_key_size_none]",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_key_size_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_value_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_cookie_value_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 32768,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_cookie_value_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_count_exceeds": {
"type": "integer",
"description": "Exclusive with [max_header_count_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 40,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_count_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_key_size_exceeds": {
      "type": "integer",
"description": "Exclusive with [max_header_key_size_none]",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_key_size_none": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_value_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_header_value_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 64000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_header_value_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_count_exceeds": {
"type": "integer",
"description": "Exclusive with [max_parameter_count_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_count_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_name_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_parameter_name_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1024,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_name_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_value_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_parameter_value_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1073741824,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_parameter_value_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_query_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_query_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_query_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_line_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_request_line_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65536,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_line_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_request_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65536,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_request_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_url_size_exceeds": {
"type": "integer",
"description": "Exclusive with [max_url_size_none]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 128000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_constraints.max_url_size_none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy": {
"type": "object",
"description": "Configure source and destination segment for policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.dst_any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.dst_segments": {
"type": "object",
"description": "List of references to Segments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.intra_segment": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.src_any": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.segment_policy.src_segments": {
"type": "object",
"description": "List of references to Segments.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher": {
"type": "object",
"description": "A TLS fingerprint matcher specifies multiple criteria for matching a TLS fingerprint. The set of supported positive match criteria includes a list of known\nclasses of TLS fingerprints and a list of exact values. The match is considered successful if either of these positive criteria are satisfied and the input\nfingerprint is not one of the excluded values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher.classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher.exact_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_fingerprint_matcher.excluded_values": {
"type": "array",
"description": "A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one\nor more known TLS fingerprint classes in the enclosing matcher.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action": {
"type": "object",
"description": "Modify App Firewall behavior for a matching request. The modification could either be to entirely skip firewall processing or to customize the firewall rules\nto be applied as defined by App Firewall Rule Control settings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action.app_firewall_detection_control": {
"type": "object",
"description": "Define the list of Signature IDs, Violations, Attack Types and Bot Names that should be excluded from triggering on the defined match criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action.none": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_action.waf_skip_processing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.asn_choice": [
"any_asn",
"asn_list",
"asn_matcher"
],
"spec.client_choice": [
"any_client",
"client_name",
"client_name_matcher",
"client_selector",
"ip_threat_category_list"
],
"spec.dst_asn_choice": [],
"spec.dst_ip_choice": [],
"spec.ip_choice": [
"any_ip",
"ip_matcher",
"ip_prefix_list"
],
"spec.tls_fingerprint_choice": [
"ja4_tls_fingerprint",
"tls_fingerprint_matcher"
],
"spec.bot_action.action_type": [
"bot_skip_processing",
"none"
],
"spec.mum_action.action_type": [
"default",
"skip_processing"
],
"spec.request_constraints.max_cookie_count_choice": [
"max_cookie_count_exceeds",
"max_cookie_count_none"
],
"spec.request_constraints.max_cookie_key_size_choice": [
      "max_cookie_key_size_exceeds",
      "max_cookie_key_size_none"
      ],
"spec.request_constraints.max_cookie_value_size_choice": [
"max_cookie_value_size_exceeds",
"max_cookie_value_size_none"
],
"spec.request_constraints.max_header_count_choice": [
"max_header_count_exceeds",
"max_header_count_none"
],
"spec.request_constraints.max_header_key_size_choice": [
      "max_header_key_size_exceeds",
      "max_header_key_size_none"
      ],
"spec.request_constraints.max_header_value_size_choice": [
"max_header_value_size_exceeds",
"max_header_value_size_none"
],
"spec.request_constraints.max_parameter_count_choice": [
"max_parameter_count_exceeds",
"max_parameter_count_none"
],
"spec.request_constraints.max_parameter_name_size_choice": [
"max_parameter_name_size_exceeds",
"max_parameter_name_size_none"
],
"spec.request_constraints.max_parameter_value_size_choice": [
"max_parameter_value_size_exceeds",
"max_parameter_value_size_none"
],
"spec.request_constraints.max_query_size_choice": [
"max_query_size_exceeds",
"max_query_size_none"
],
"spec.request_constraints.max_request_line_size_choice": [
"max_request_line_size_exceeds",
"max_request_line_size_none"
],
"spec.request_constraints.max_request_size_choice": [
"max_request_size_exceeds",
"max_request_size_none"
],
"spec.request_constraints.max_url_size_choice": [
"max_url_size_exceeds",
"max_url_size_none"
],
"spec.segment_policy.dst_segment_choice": [
"dst_any",
"dst_segments",
"intra_segment"
],
"spec.segment_policy.src_segment_choice": [
"src_any",
"src_segments"
],
"spec.waf_action.action_type": [
"app_firewall_detection_control",
"none",
"waf_skip_processing"
]
}
},
{
"name": "list_service_policy_rules",
"description": "List Service Policy Rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/service_policy_rules",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_service_policy_rule",
"description": "DELETE Service Policy Rule.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/service_policy_rules/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a service_policy_rule",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.service_policy_rule.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for service_policy_ruleDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for service_policy_ruleDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_service_policy_rule",
"description": "GET Service Policy Rule.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/service_policy_rules/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"service-policy-sets": {
"name": "service-policy-sets",
"displayName": "Service Policy Sets",
"operations": [
{
"name": "list_service_policy_sets",
"description": "List Service Policy Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/service_policy_sets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_service_policy_set",
"description": "GET Service Policy Set.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/service_policy_sets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"service-policys": {
"name": "service-policys",
"displayName": "Service Policys",
"operations": [
{
"name": "create_service_policy",
"description": "Create Service Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/service_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of service_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.service_policy.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/schemaservice_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Service policy for network-level access control and traffic rules",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "rule_choice",
"fields": [
"spec.allow_all_requests",
"spec.deny_all_requests",
"spec.rule_list"
],
"reason": "Choose exactly one rule selection method (REQUIRED)"
},
{
"name": "server_choice",
"fields": [
"spec.any_server",
"spec.server_name",
"spec.server_selector",
"spec.server_name_matcher"
],
"reason": "Choose server scope (default: any_server)"
}
],
"example_yaml": "apiVersion: v1\nkind: service_policy\nmetadata:\n  name: allow-all\n  namespace: default\nspec:\n  allow_all_requests: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"allow-all\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"allow_all_requests\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "allow-all",
"namespace": "default"
},
"spec": {
"allow_all_requests": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Service policy for network-level access control and traffic rules"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create service_policy creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_requests": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list": {
"type": "object",
"description": "List of sources. A request belongs to this list if it satisfies any of the match criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.asn_set": {
"type": "array",
"description": "Addresses that belong to the ASNs in the given bgp_asn_set\nThe ASN is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.country_list": {
"type": "array",
"description": "Addresses that belong to one of the countries in the given list\nThe country is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.ip_prefix_set": {
"type": "array",
"description": "Addresses that are covered by the prefixes in the given ip_prefix_set.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.tls_fingerprint_classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.tls_fingerprint_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_server": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all_requests": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list": {
"type": "object",
"description": "List of sources. A request belongs to this list if it satisfies any of the match criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.asn_set": {
"type": "array",
"description": "Addresses that belong to the ASNs in the given bgp_asn_set\nThe ASN is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.country_list": {
"type": "array",
"description": "Addresses that belong to one of the countries in the given list\nThe country is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.ip_prefix_set": {
"type": "array",
"description": "Addresses that are covered by the prefixes in the given ip_prefix_set.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.tls_fingerprint_classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.tls_fingerprint_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list": {
"type": "object",
"description": "A list of rules.\nThe order of evaluation of the rules depends on the rule combining algorithm.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list.rules": {
"type": "array",
"description": "Define the list of rules (with an order) that should be evaluated by this service policy.\nRules are evaluated from top to bottom in the list.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name": {
"type": "string",
"description": "Exclusive with [any_server server_name_matcher server_selector]\nThe expected name of the server to which the request API is directed. The actual names for the server are extracted from the HTTP Host header and the name\nof the virtual_host to which the request is directed. If the request is directed to a virtual K8s service, the actual names also contain the name of that\nservice.\nThe predicate evaluates to true if any of the actual names is the same as the expected server name.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.rule_choice": [
"allow_all_requests",
"allow_list",
"deny_all_requests",
"deny_list",
"rule_list"
],
"spec.server_choice": [
"any_server",
"server_name",
"server_name_matcher",
"server_selector"
],
"spec.allow_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
],
"spec.deny_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_service_policy",
"description": "Replace Service Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/service_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a service_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.service_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemaservice_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Service policy for network-level access control and traffic rules",
      "required_fields": [
"metadata.name",
"metadata.namespace"
],
"mutually_exclusive_groups": [
{
"name": "rule_choice",
"fields": [
"spec.allow_all_requests",
"spec.deny_all_requests",
"spec.rule_list"
],
"reason": "Choose exactly one rule selection method (REQUIRED)"
},
{
"name": "server_choice",
"fields": [
"spec.any_server",
"spec.server_name",
"spec.server_selector",
"spec.server_name_matcher"
],
"reason": "Choose server scope (default: any_server)"
}
],
"example_yaml": "apiVersion: v1\nkind: service_policy\nmetadata:\n  name: allow-all\n  namespace: default\nspec:\n  allow_all_requests: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"allow-all\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"allow_all_requests\": {}\n  }\n}\n"
},
"x-f5xc-cli-domain": "network_security"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "allow-all",
"namespace": "default"
},
"spec": {
"allow_all_requests": {}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace"
],
"description": "Service policy for network-level access control and traffic rules"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace service_policy replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_requests": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list": {
"type": "object",
"description": "List of sources. A request belongs to this list if it satisfies any of the match criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.asn_set": {
"type": "array",
"description": "Addresses that belong to the ASNs in the given bgp_asn_set\nThe ASN is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.country_list": {
"type": "array",
"description": "Addresses that belong to one of the countries in the given list\nThe country is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.ip_prefix_set": {
"type": "array",
"description": "Addresses that are covered by the prefixes in the given ip_prefix_set.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.tls_fingerprint_classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_list.tls_fingerprint_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.any_server": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all_requests": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list": {
"type": "object",
"description": "List of sources. A request belongs to this list if it satisfies any of the match criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.asn_list": {
"type": "object",
"description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.asn_set": {
"type": "array",
"description": "Addresses that belong to the ASNs in the given bgp_asn_set\nThe ASN is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.country_list": {
"type": "array",
"description": "Addresses that belong to one of the countries in the given list\nThe country is obtained by performing a lookup for the source IPv4 Address in a GeoIP DB.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_allow": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_deny": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.default_action_next_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.ip_prefix_set": {
"type": "array",
"description": "Addresses that are covered by the prefixes in the given ip_prefix_set.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.prefix_list": {
"type": "object",
"description": "List of IPv4 prefixes that represent an endpoint.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.tls_fingerprint_classes": {
"type": "array",
"description": "A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_list.tls_fingerprint_values": {
"type": "array",
"description": "A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list": {
"type": "object",
"description": "A list of rules.\nThe order of evaluation of the rules depends on the rule combining algorithm.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rule_list.rules": {
"type": "array",
"description": "Define the list of rules (with an order) that should be evaluated by this service policy.\nRules are evaluated from top to bottom in the list.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"minItems": 0,
"uniqueItems": false,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name": {
"type": "string",
"description": "Exclusive with [any_server server_name_matcher server_selector]\nThe expected name of the server to which the request API is directed. The actual names for the server are extracted from the HTTP Host header and the name\nof the virtual_host to which the request is directed. If the request is directed to a virtual K8s service, the actual names also contain the name of that\nservice.\nThe predicate evaluates to true if any of the actual names is the same as the expected server name.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"byteLength": {
"max": 256
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher": {
"type": "object",
"description": "A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.exact_values": {
"type": "array",
"description": "A list of exact values to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name_matcher.regex_values": {
"type": "array",
"description": "A list of regular expressions to match the input against.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.rule_choice": [
"allow_all_requests",
"allow_list",
"deny_all_requests",
"deny_list",
"rule_list"
],
"spec.server_choice": [
"any_server",
"server_name",
"server_name_matcher",
"server_selector"
],
"spec.allow_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
],
"spec.deny_list.default_action_choice": [
"default_action_allow",
"default_action_deny",
"default_action_next_policy"
]
}
},
{
"name": "list_service_policys",
"description": "List Service Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/service_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_service_policy",
"description": "DELETE Service Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/service_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a service_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.service_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for service_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for service_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network_security"
}
},
{
"name": "get_service_policy",
"description": "GET Service Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/service_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"services-api-endpoint-pdf": {
"name": "services-api-endpoint-pdf",
      "displayName": "Services Api Endpoint Pdf",
      "operations": [
{
"name": "create_services_api_endpoint_pdf",
      "description": "GET Service API Endpoint PDF.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/services/{service_name}/api_endpoint/pdf",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "service_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Shape of request to GET PDF for a given API endpoint.",
      "title": "Service API endpoint PDF request",
      "x-displayname": "Per Service API Endpoint PDF Request.",
      "x-ves-proto-message": "ves.io.schema.app_type.ServiceAPIEndpointPDFReq",
      "properties": {
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"title": "App Type",
"x-displayname": "App Type",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"collapsed_url": {
"type": "string",
"description": "API endpoint for which PDFs are requested.",
      "title": "Discovered API URL",
      "x-displayname": "API URL",
      "x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "API endpoint for which PDFs are requested.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Method of API endpoint for which PDFs are requested.",
      "title": "Method of current API URL",
      "x-displayname": "Method",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Method of API endpoint for which PDFs are requested.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"service_name": {
"type": "string",
"description": "Identifies the destination service.",
"title": "Service",
"x-displayname": "Service Name.",
"x-ves-example": "N:public or S:productpage.",
"x-f5xc-example": "N:public or S:productpage",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Shape of request to GET PDF for a given API endpoint.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_typeServiceAPIEndpointPDFReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeServiceAPIEndpointPDFReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeServiceAPIEndpointPDFReq"
      },
"fieldMetadata": {
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"collapsed_url": {
"type": "string",
"description": "API endpoint for which PDFs are requested.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"method": {
"type": "string",
"description": "Method of API endpoint for which PDFs are requested.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"service_name": {
"type": "string",
"description": "Identifies the destination service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "pdf_info",
"type": "object",
"description": ""
}
]
}
]
},
	"services-api-endpoints": {
"name": "services-api-endpoints",
      "displayName": "Services Api Endpoints",
      "operations": [
{
"name": "create_services_api_endpoint",
      "description": "GET Service API Endpoints.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/services/{service_name}/api_endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "app_type_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "service_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for GET Service API endpoints API.",
      "title": "API endpoints per service GET request",
      "x-displayname": "Service API Endpoints Request.",
      "x-ves-proto-message": "ves.io.schema.app_type.ServiceAPIEndpointsReq",
      "properties": {
"api_endpoint_info_request": {
      "type": "array",
"description": "List of additional things that needs to be sent as part of the request.",
"title": "Api Endpoint Info Request",
      "items": {
"$ref": "#/components/schemas/app_typeApiEndpointInfoRequest"
      },
"x-displayname": "API Endpoint Info Request.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "List of additional things that needs to be sent as part of the request.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"title": "App Type",
"x-displayname": "App Type",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"service_name": {
"type": "string",
"description": "Identifies the destination service.",
"title": "Service",
"x-displayname": "Service Name.",
"x-ves-example": "N:public or S:productpage.",
"x-f5xc-example": "N:public or S:productpage",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request shape for GET Service API endpoints API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_typeServiceAPIEndpointsReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_typeServiceAPIEndpointsReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {
"apiep_list": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_typeServiceAPIEndpointsReq"
      },
"fieldMetadata": {
"api_endpoint_info_request": {
      "type": "array",
"description": "List of additional things that needs to be sent as part of the request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"app_type_name": {
"type": "string",
"description": "App Type for current request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"service_name": {
"type": "string",
"description": "Identifies the destination service.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiep_list",
      "type": "array",
"description": "List of API endpoints discovered."
      }
]
}
]
},
	"set-cloud-site-info": {
"name": "set-cloud-site-info",
"displayName": "Set Cloud Site Info",
"operations": [
{
"name": "create_set_cloud_site_info",
"description": "Configure AWS VPC Site Information.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_cloud_site_info",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to configure Cloud Site Information.",
"title": "Request to configure Cloud Site Information",
"x-displayname": "Request to configure Cloud Site Information.",
"x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetCloudSiteInfoRequest",
"properties": {
"aws_vpc_info": {
"allOf": [
{
"$ref": "#/components/schemas/aws_vpc_siteAWSVPCSiteInfoType"
}
],
"x-f5xc-description-short": "Configuration parameter for aws vpc info.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"direct_connect_info": {
"allOf": [
{
"$ref": "#/components/schemas/viewsDirectConnectInfo"
}
],
"x-f5xc-description-short": "Configuration parameter for direct connect info.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-VPC-site-1.",
"x-f5xc-example": "aws-vpc-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to configure Cloud Site Information.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_vpc_siteSetCloudSiteInfoRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_vpc_siteSetCloudSiteInfoRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_vpc_siteSetCloudSiteInfoRequest"
},
"fieldMetadata": {
"aws_vpc_info": {
"type": "object",
"description": "AWS VPC Site information like.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"aws_vpc_info.private_ips": {
"type": "array",
"description": "AWS Private IPs used by the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"aws_vpc_info.public_ips": {
"type": "array",
"description": "AWS Elastic IPs used by the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"aws_vpc_info.subnet_ids": {
"type": "array",
"description": "AWS Subnet Info where the F5XC site is deployed.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"aws_vpc_info.vpc_id": {
"type": "string",
"description": "VPC ID where the F5 Distributed Cloud site exists.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$|^$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"aws_vpc_info.vpc_name": {
"type": "string",
"description": "VPC Name where the F5 Distributed Cloud site exists.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"direct_connect_info": {
"type": "object",
"description": "DirectConnect Info.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"direct_connect_info.asn": {
"type": "integer",
"description": "The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 4294967294,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"direct_connect_info.direct_connect_gateway_id": {
"type": "string",
"description": "DirectConnect Gateway ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"direct_connect_info.vgw_id": {
"type": "string",
"description": "Virtual Private Gateway ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"set-log-anonymization": {
"name": "set-log-anonymization",
"displayName": "Set Log Anonymization",
"operations": [
{
"name": "create_set_log_anonymization",
"description": "Log Anonymization Mode.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/fleets/{name}/set-log-anonymization",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request message for setting log anonymization choice for the fleet Object.",
"title": "LogAnonymizationRequest",
"x-displayname": "Log Anonymization Request.",
"x-ves-proto-message": "ves.io.schema.fleet.SetLogAnonymizationRequest",
"properties": {
"enabled": {
"type": "boolean",
"description": "Log anonymization enablement for the fleet Object, false to disable and true to enable.",
"title": "Anonymization enablement",
"format": "boolean",
"x-displayname": "Anonymization Enabled.",
"x-f5xc-example": "True",
"x-f5xc-description-short": "Log anonymization enablement for the fleet Object, false to disable and true to enable.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the Fleet object.",
"title": "Name of the Fleet object",
"x-displayname": "Fleet Name.",
"x-f5xc-example": "example-resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the Fleet object.",
"title": "Namespace of the Fleet object",
"x-displayname": "Fleet Namespace.",
"x-f5xc-example": "example-resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request message for setting log anonymization choice for the fleet Object.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for fleetSetLogAnonymizationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for fleetSetLogAnonymizationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for fleetSetLogAnonymizationRequest"
},
"fieldMetadata": {
"enabled": {
"type": "boolean",
"description": "Log anonymization enablement for the fleet Object, false to disable and true to enable.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the Fleet object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the Fleet object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"set-tgw-info": {
"name": "set-tgw-info",
"displayName": "Set Tgw Info",
"operations": [
{
"name": "create_set_tgw_info",
"description": "Configure TGW Information.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_tgw_info",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to configure TGW Information.",
"title": "Request to configure TGW Information",
"x-displayname": "Request to configure TGW Information.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetTGWInfoRequest",
"properties": {
"direct_connect_info": {
"allOf": [
{
"$ref": "#/components/schemas/viewsDirectConnectInfo"
}
],
"x-f5xc-description-short": "Configuration parameter for direct connect info.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-tgw-site-1.",
"x-f5xc-example": "aws-tgw-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"tgw_info": {
"allOf": [
{
"$ref": "#/components/schemas/aws_tgw_siteAWSTGWInfoConfigType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_tgw_siteSetTGWInfoRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteSetTGWInfoRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_tgw_siteSetTGWInfoRequest"
},
"fieldMetadata": {
"direct_connect_info": {
"type": "object",
"description": "DirectConnect Info.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"direct_connect_info.asn": {
"type": "integer",
"description": "The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 4294967294,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"direct_connect_info.direct_connect_gateway_id": {
"type": "string",
"description": "DirectConnect Gateway ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"direct_connect_info.vgw_id": {
"type": "string",
"description": "Virtual Private Gateway ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tgw_info": {
"type": "object",
"description": "AWS tgw information like tgw-ID and site's VPC-ID.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tgw_info.private_ips": {
"type": "array",
"description": "AWS Private IPs used by the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tgw_info.public_ips": {
"type": "array",
"description": "AWS Elastic IPs used by the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tgw_info.subnet_ids": {
"type": "array",
"description": "AWS Subnet IDs used by F5 Distributed Cloud site.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tgw_info.tgw_id": {
"type": "string",
"description": "TGW ID populated by AWS.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tgw_info.vpc_id": {
"type": "string",
"description": "VPC ID where the F5 Distributed Cloud site exists.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tgw_info.vpc_name": {
"type": "string",
"description": "VPC Name where the F5 Distributed Cloud site exists.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"set-vip-info": {
"name": "set-vip-info",
"displayName": "Set Vip Info",
"operations": [
{
"name": "create_set_vip_info",
"description": "Configure AWS TGW Site VIP Information.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vip_info",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to configure AWS TGW Site VIP information.",
"title": "Request to configure AWS TGW Site VIP information",
"x-displayname": "Request to configure AWS TGW Site VIP information.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVIPInfoRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-tgw-site-1.",
"x-f5xc-example": "aws-tgw-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"vip_params_per_az": {
"type": "array",
"description": "VIP Parameters per AZ.",
"title": "VIP Params Per AZ",
"items": {
"$ref": "#/components/schemas/sitePublishVIPParamsPerAz__ves_io_schema_views_aws_tgw_site"
},
"x-displayname": "VIP Params Per AZ.",
"x-ves-example": "Master-0",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.num_items": "1,2,3"
},
"x-f5xc-example": "master-0",
"x-validation-rules": {
"ves.io.schema.rules.repeated.num_items": "1,2,3"
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to configure AWS TGW Site VIP information.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_tgw_siteSetVIPInfoRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteSetVIPInfoRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_tgw_siteSetVIPInfoRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vip_params_per_az": {
"type": "array",
"description": "VIP Parameters per AZ.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"set-vpc-ip-prefixes": {
"name": "set-vpc-ip-prefixes",
"displayName": "Set Vpc Ip Prefixes",
"operations": [
{
"name": "create_set_vpc_ip_prefixe",
"description": "Configure VPC IP prefixes.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpc_ip_prefixes",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to configure VPC IP prefix set.",
"title": "Request to configure VPC IP prefix set",
"x-displayname": "Request to configure VPC IP prefix set.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVPCIpPrefixesRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-tgw-site-1.",
"x-f5xc-example": "aws-tgw-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"vpc_ip_prefixes": {
"type": "object",
"description": "IP prefixes of subnets in the VPC.",
"title": "VPC IP Prefixes",
"x-displayname": "VPC IP Prefixes.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_tgw_siteSetVPCIpPrefixesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteSetVPCIpPrefixesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_tgw_siteSetVPCIpPrefixesRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vpc_ip_prefixes": {
"type": "object",
"description": "IP prefixes of subnets in the VPC.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"set-vpn-tunnels": {
"name": "set-vpn-tunnels",
"displayName": "Set Vpn Tunnels",
"operations": [
{
"name": "create_set_vpn_tunnel",
"description": "Configure VPN Tunnels.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpn_tunnels",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to configure VPN Tunnels.",
"title": "Request to configure VPN Tunnels",
"x-displayname": "Request to configure VPN Tunnels.",
"x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVPNTunnelsRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-tgw-site-1.",
"x-f5xc-example": "aws-tgw-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_tgw_siteSetVPNTunnelsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_tgw_siteSetVPNTunnelsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_tgw_siteSetVPNTunnelsRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"settings": {
"name": "settings",
"displayName": "Settings",
"operations": [
{
"name": "list_settings",
"description": "Module Management Settings.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/module_management/settings",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "glr_configuration",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-alerts": {
"name": "shape-alerts",
"displayName": "Shape Alerts",
"operations": [
{
"name": "create_shape_alert",
"description": "Create Alert Generation Policy.",
"method": "POST",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of alert_gen_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/brmalertsalert_gen_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_gen_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_gen_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alert_gen_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Alert Generation Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.alert_status": {
"type": "string",
"description": "List of alert statuses\n\nActive\nInactive.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ALERT_ACTIVE"
},
"spec.details": {
"type": "object",
"description": "Notification Details.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.details.alert_message": {
"type": "string",
"description": "Alert Message.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.details.alert_message_details": {
"type": "string",
"description": "Detailed message of the alert.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.details.alert_name": {
"type": "string",
"description": "Alert Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.details.severity": {
"type": "string",
"description": "List of alert severities\n\nMinor\nMajor\nCritical.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MINOR"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_shape_alert",
"description": "Replace Alert Generation Policy.",
"method": "PUT",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a alert_gen_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/brmalertsalert_gen_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_gen_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_gen_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alert_gen_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of an Alert Generation Policy object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.alert_status": {
"type": "string",
"description": "List of alert statuses\n\nActive\nInactive.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ALERT_ACTIVE"
},
"spec.details": {
"type": "object",
"description": "Notification Details.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.details.alert_message": {
"type": "string",
"description": "Alert Message.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.details.alert_message_details": {
"type": "string",
"description": "Detailed message of the alert.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.details.alert_name": {
"type": "string",
"description": "Alert Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.details.severity": {
"type": "string",
"description": "List of alert severities\n\nMinor\nMajor\nCritical.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "MINOR"
}
}
},
{
"name": "list_shape_alerts",
"description": "List BRM Alert Generation Policy.",
"method": "GET",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_shape_alert",
"description": "DELETE BRM Alert Generation Policy.",
"method": "DELETE",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a alert_gen_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_gen_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_gen_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
}
},
{
"name": "get_shape_alert",
"description": "GET Alert Generation Policy.",
"method": "GET",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"shape-alerts-clone": {
"name": "shape-alerts-clone",
"displayName": "Shape Alerts Clone",
"operations": [
{
"name": "create_shape_alerts_clone",
"description": "Clone Alert Template.",
"method": "POST",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_templates/{name}/clone",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to clone template.",
"title": "CloneTemplateRequest",
"x-displayname": "Clone Template Request.",
"x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.CloneTemplateRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert template to be cloned.",
"title": "name",
"x-displayname": "Name",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "The name of the alert template to be cloned.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the the alert template is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "The namespace in which the the alert template is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_templateCloneTemplateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_templateCloneTemplateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"alert_name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alert_templateCloneTemplateRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the alert template to be cloned.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the the alert template is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "alert_name",
"type": "string",
"description": "The name of the alert created from template."
}
]
}
]
},
	"shape-alerts-status": {
"name": "shape-alerts-status",
"displayName": "Shape Alerts Status",
"operations": [
{
"name": "create_shape_alerts_statu",
"description": "Clone Alert Template.",
"method": "POST",
"path": "/api/shape/alerts/namespaces/{namespace}/alert_gen_policy/{name}/status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to change status of alert.",
"title": "ChangeAlertStatusRequest",
"x-displayname": "Change Alert Status Request.",
"x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ChangeAlertStatusRequest",
"properties": {
"name": {
"type": "string",
"description": "The name of the alert.",
"title": "name",
"x-displayname": "Name",
"x-f5xc-example": "example-resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace in which the the alert is present.",
"title": "namespace",
"x-displayname": "Namespace",
"x-f5xc-example": "example-resource",
"x-f5xc-description-short": "The namespace in which the the alert is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/alert_gen_policyAlertStatus"
}
],
"x-f5xc-example": "active",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for alert_gen_policyChangeAlertStatusRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for alert_gen_policyChangeAlertStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for alert_gen_policyChangeAlertStatusRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "The name of the alert.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace in which the the alert is present.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"status": {
"type": "string",
"description": "List of alert statuses\n\nActive\nInactive.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "ALERT_ACTIVE"
}
}
}
]
},
	"shape-bot": {
"name": "shape-bot",
"displayName": "Shape Bot",
"operations": [
{
"name": "replace_shape_bot",
"description": "Replace Bot allowlist Policy.",
"method": "PUT",
"path": "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a bot_allowlist_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/bot_allowlist_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bot_allowlist_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_allowlist_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bot_allowlist_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Bot allowlist Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowlist_policy_content": {
"type": "object",
"description": "Allowlist Policy Content.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowlist_policy_content.ip_allowlist": {
"type": "array",
"description": "Allowlist or permitted items",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowlist_policy_content.ip_range_allowlist": {
"type": "array",
"description": "Allowlist or permitted items",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "create_shape_bot",
"description": "Create Bot Infrastructure.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/bot_infrastructures",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of bot_infrastructure",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.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/bot_infrastructureCreateSpecType"
}
],
"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 bot_infrastructureCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_infrastructureCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bot_infrastructureCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Bot Infrastructure.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.create_cloud_hosted": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.create_cloud_hosted.ip_addresses": {
"type": "array",
"description": "Only traffic from these IP addresses is allowed to access this Bot Defense infrastructure.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.create_cloud_hosted.production": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.create_cloud_hosted.testing": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.traffic_type": {
"type": "string",
"description": "The type of traffic that is routed to and processed by this infrastructure (Web or Mobile).\n\nOnly web traffic, including browser-based traffic from mobile devices, is routed through this Bot Defense infrastructure.\nOnly mobile traffic from native mobile apps with the Bot Defense SDK are routed through this Bot Defense infrastructure.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "WEB"
}
},
"oneOfVariants": {
"spec.create_bot_infra_choice": [
"create_cloud_hosted"
],
"spec.create_cloud_hosted.type_choice": [
"production",
"testing"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "list_shape_bot",
"description": "List Bot allowlist Policy.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_shape_bot",
"description": "GET Bot allowlist Policy.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
},
{
"name": "delete_shape_bot",
"description": "DELETE Certificate By ID.",
"method": "DELETE",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/{cert_id}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "cert_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "certificate_detail",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-add-to-csr": {
"name": "shape-bot-add-to-csr",
"displayName": "Shape Bot Add To Csr",
"operations": [
{
"name": "create_shape_bot_add_to_csr",
"description": "Add Certificate to CSR.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/add-to-csr",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to add a certificate to an existing CSR.",
"title": "AddCertificateToCsrRequest",
"x-displayname": "Add Certificate to CSR Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.AddCertificateToCsrRequest",
"properties": {
"certificate_content": {
"allOf": [
{
"$ref": "#/components/schemas/custom_certificateCertificateContentForCsr"
}
],
"x-f5xc-description-short": "Configuration parameter for certificate content.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Certificate Name",
"minLength": 1,
"x-displayname": "Certificate Name.",
"x-ves-example": "Test-certificate.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "test-certificate",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to add a certificate to an existing CSR.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for custom_certificateAddCertificateToCsrRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for custom_certificateAddCertificateToCsrRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for custom_certificateAddCertificateToCsrRequest"
},
"fieldMetadata": {
"certificate_content": {
"type": "object",
"description": "Certificate content to add to an existing CSR.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"certificate_content.cert": {
"type": "string",
"description": "Certificate in PEM format.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"certificate_content.csr_id": {
"type": "string",
"description": "Unique identifier for this resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "certificate_detail",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-add-with-private-key": {
"name": "shape-bot-add-with-private-key",
      "displayName": "Shape Bot Add With Private Key",
      "operations": [
{
"name": "create_shape_bot_add_with_private_key",
      "description": "Add Certificate with Private Key.",
      "method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/add-with-private-key",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to add a certificate with private key.",
      "title": "AddCertificateWithPrivateKeyRequest",
      "x-displayname": "Add Certificate with Private Key Request.",
      "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.AddCertificateWithPrivateKeyRequest",
      "properties": {
"certificate_content": {
"allOf": [
{
"$ref": "#/components/schemas/custom_certificateCertificateContentWithPrivateKey"
      }
],
"x-f5xc-description-short": "Configuration parameter for certificate content.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Certificate Name",
"minLength": 1,
"x-displayname": "Certificate Name.",
"x-ves-example": "Test-certificate.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "test-certificate",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to add a certificate with private key.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for custom_certificateAddCertificateWithPrivateKeyRequest",
      "required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for custom_certificateAddCertificateWithPrivateKeyRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for custom_certificateAddCertificateWithPrivateKeyRequest"
      },
"fieldMetadata": {
"certificate_content": {
"type": "object",
"description": "Certificate content with private key.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"certificate_content.cert": {
"type": "string",
"description": "Certificate in PEM format.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"certificate_content.pkey": {
      "type": "string",
"description": "Private key in PEM format.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "certificate_detail",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-apikey": {
"name": "shape-bot-apikey",
      "displayName": "Shape Bot Apikey",
      "operations": [
{
"name": "list_shape_bot_apikey",
      "description": "API Key",
      "method": "GET",
"path": "/api/shape/bot/namespaces/system/apikey",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"api_key": {
      "type": "string"
}
}
},
"responseSummary": [
{
"field": "api_key",
      "type": "string",
"description": "API Key"
      }
]
}
]
},
	"shape-bot-apply-certificate": {
"name": "shape-bot-apply-certificate",
"displayName": "Shape Bot Apply Certificate",
"operations": [
{
"name": "replace_shape_bot_apply_certificate",
"description": "Apply Certificate.",
"method": "PUT",
"path": "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/apply-certificate",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for applying certificate.",
"title": "ApplyCertificateRequest",
"x-displayname": "Apply Certificate Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ApplyCertificateRequest",
"properties": {
"name": {
"type": "string",
"description": "Bot Infrastructure Name.",
"title": "Bot Infrastructure Name",
"x-displayname": "Bot Infrastructure Name.",
"x-ves-example": "Cluster_1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "cluster_1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region_list": {
"type": "array",
"description": "List of region and certificate pairs to rollback.",
"title": "Region List",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/bot_infrastructureApplyCertificateRegion"
},
"x-displayname": "Region List.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-f5xc-description-short": "List of region and certificate pairs to rollback.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bot_infrastructureApplyCertificateRequest",
"required_fields": [
"name",
"namespace",
"region_list"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_infrastructureApplyCertificateRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  region_list: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"region_list\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"region_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"region_list": "value"
}
},
"requiredFields": [
"name",
"namespace",
"region_list"
],
"description": "Minimum configuration for bot_infrastructureApplyCertificateRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Bot Infrastructure Name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region_list": {
"type": "array",
"description": "List of region and certificate pairs to rollback.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "name",
"type": "string",
"description": "Name of the cluster."
},
{
"field": "region_list",
"type": "array",
"description": "List of region status for certificate operation."
}
]
}
]
},
	"shape-bot-archive": {
"name": "shape-bot-archive",
"displayName": "Shape Bot Archive",
"operations": [
{
"name": "replace_shape_bot_archive",
"description": "Archive Certificate By ID.",
"method": "PUT",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/{cert_id}/archive",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "cert_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to archive certificate by ID.",
"title": "ArchiveCertificateByIDRequest",
"x-displayname": "Archive Certificate By ID Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.ArchiveCertificateByIDRequest",
"properties": {
"cert_id": {
"type": "string",
"description": "Unique identifier for this resource",
"title": "Certificate ID",
"x-displayname": "Certificate ID.",
"x-ves-example": "65b73012a44742000137f379.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "65b73012a44742000137f379",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for custom_certificateArchiveCertificateByIDRequest",
"required_fields": [
"cert_id",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for custom_certificateArchiveCertificateByIDRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  cert_id: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"cert_id\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"cert_id": "value",
"namespace": "value"
}
},
"requiredFields": [
"cert_id",
"namespace"
],
"description": "Minimum configuration for custom_certificateArchiveCertificateByIDRequest"
},
"fieldMetadata": {
"cert_id": {
"type": "string",
"description": "Unique identifier for this resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "certificate_detail",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-atb": {
"name": "shape-bot-atb",
"displayName": "Shape Bot Atb",
"operations": [
{
"name": "list_shape_bot_atb",
"description": "ATB Status.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/atb",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "virtual_host",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
}
}
},
"responseSummary": [
{
"field": "enable",
"type": "boolean",
"description": "Enable ATB or not."
}
]
},
{
"name": "create_shape_bot_atb",
"description": "ATB",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/atb",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for ATB.",
"title": "ATBRequest",
"x-displayname": "Request for ATB.",
"x-ves-oneof-field-frequency": "[\"daily\",\"monthly\",\"weekly\"]",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ATBRequest",
"properties": {
"daily": {
"allOf": [
{
"$ref": "#/components/schemas/report_configReportFreqDaily"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"enable": {
"type": "boolean",
"description": "Enable ATB or not.",
"title": "Enable",
"format": "boolean",
"x-displayname": "Enable",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"monthly": {
"allOf": [
{
"$ref": "#/components/schemas/report_configReportFreqMonthly"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"resource_id": {
"type": "string",
"description": "Resource ID of ATB report configuration object.",
"title": "Resource ID",
"x-displayname": "Resource ID.",
"x-ves-example": "1234567",
"x-f5xc-example": "1234567",
"x-f5xc-description-short": "Resource ID of ATB report configuration object.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "identifier",
"maxLength": 1024,
"minLength": 1,
"pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$",
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"weekly": {
"allOf": [
{
"$ref": "#/components/schemas/report_configReportFreqWeekly"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingATBRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingATBRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"enable": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingATBRequest"
},
"fieldMetadata": {
"daily": {
"type": "object",
"description": "Create report daily.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"daily.report_generation_time": {
"type": "string",
"description": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"enable": {
"type": "boolean",
"description": "Enable ATB or not.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"monthly": {
"type": "object",
"description": "Create report monthly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"monthly.date": {
"type": "string",
"description": "Report generation date\n\nIndicates field not being set\nCreate report on Last day of month.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DATE_NONE"
},
"monthly.report_generation_time": {
"type": "string",
"description": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_id": {
"type": "string",
"description": "Resource ID of ATB report configuration object.",
"constraints": {
"constraintType": "string",
"category": "identifier",
"maxLength": 1024,
"minLength": 1,
"pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$",
"metadata": {
"source": "inferred",
"confidence": 0.8,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"weekly": {
"type": "object",
"description": "Create report weekly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"weekly.day": {
"type": "string",
"description": "Report generation weekday\n\nIndicates field not being set.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "WEEKDAY_NONE"
},
"weekly.report_generation_time": {
"type": "string",
"description": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"frequency": [
"daily",
"monthly",
"weekly"
]
},
"responseSummary": [
{
"field": "enable",
"type": "boolean",
"description": "Enable ATB or not."
}
]
}
]
},
	"shape-bot-bot-defense-addon-subscribe": {
"name": "shape-bot-bot-defense-addon-subscribe",
"displayName": "Shape Bot Bot Defense Addon Subscribe",
"operations": [
{
"name": "create_shape_bot_bot_defense_addon_subscribe",
"description": "Subscribe to Shape Bot Defense.",
"method": "POST",
"path": "/api/shape/bot/namespaces/system/bot-defense/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Shape Bot Defense.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-oneof-field-tier": "[\"standard\"]",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.SubscribeRequest",
"properties": {
"standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to subscribe to Shape Bot Defense.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
},
"fieldMetadata": {
"standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"tier": [
"standard"
]
}
}
]
},
	"shape-bot-bot-defense-addon-unsubscribe": {
"name": "shape-bot-bot-defense-addon-unsubscribe",
"displayName": "Shape Bot Bot Defense Addon Unsubscribe",
"operations": [
{
"name": "create_shape_bot_bot_defense_addon_unsubscribe",
"description": "Unsubscribe to Shape Bot Defense.",
"method": "POST",
"path": "/api/shape/bot/namespaces/system/bot-defense/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Shape Bot Defense.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to Shape Bot Defense.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"shape-bot-consumption-summary": {
"name": "shape-bot-consumption-summary",
"displayName": "Shape Bot Consumption Summary",
"operations": [
{
"name": "list_shape_bot_consumption_summary",
"description": "Consumption Summary.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/consumption/summary",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"sums": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "sums",
"type": "array",
"description": "Consumption summary data."
}
]
}
]
},
	"shape-bot-csr": {
"name": "shape-bot-csr",
"displayName": "Shape Bot Csr",
"operations": [
{
"name": "delete_shape_bot_csr",
"description": "DELETE CSR By ID.",
"method": "DELETE",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/csr/{csr_id}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "csr_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "csr_detail",
"type": "object",
"description": ""
}
]
},
{
"name": "get_shape_bot_csr",
"description": "GET CSR By ID.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/csr/{csr_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "csr_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "csr_detail",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-custom": {
"name": "shape-bot-custom",
"displayName": "Shape Bot Custom",
"operations": [
{
"name": "list_shape_bot_custom",
"description": "List All Bot Allowlist Policies And Versions.",
"method": "GET",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_allowlist_policies",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"policies": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "policies",
"type": "array",
"description": "Policy"
}
]
},
{
"name": "replace_shape_bot_custom",
"description": "Custom Replace Bot allowlist Policy.",
"method": "PUT",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_allowlist_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"title": "CustomReplaceRequest is used to replace contents of a bot_allowlist_policy",
"x-displayname": "Custom Replace Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomReplaceRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the policy.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/bot_allowlist_policyReplaceSpecType"
}
],
"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 bot_allowlist_policyCustomReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_allowlist_policyCustomReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bot_allowlist_policyCustomReplaceRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the policy.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Bot allowlist Policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowlist_policy_content": {
"type": "object",
"description": "Allowlist Policy Content.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowlist_policy_content.ip_allowlist": {
"type": "array",
"description": "Allowlist or permitted items",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowlist_policy_content.ip_range_allowlist": {
"type": "array",
"description": "Allowlist or permitted items",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "create_shape_bot_custom",
"description": "Deploy Bot Detection Rules.",
"method": "POST",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for deploy bot detection rules.",
"title": "DeployBotDetectionRulesRequest",
"x-displayname": "Deploy Bot Detection Rules Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DeployBotDetectionRulesRequest",
"properties": {
"comments": {
"type": "string",
"description": "Deployment Comments.",
"title": "Comments",
"x-displayname": "Comments",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config_change_per_bot_detection_rule": {
"type": "array",
"description": "Config change per bot detection rules.",
"title": "Config Change Per Bot Detection Rules",
"items": {
"$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange"
},
"x-displayname": "Config Change Per Bot Detection Rules.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "namespace",
"minLength": 1,
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+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 bot_detection_ruleDeployBotDetectionRulesRequest",
"required_fields": [
"config_change_per_bot_detection_rule",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_detection_ruleDeployBotDetectionRulesRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  config_change_per_bot_detection_rule: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"config_change_per_bot_detection_rule\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"config_change_per_bot_detection_rule": "value",
"namespace": "value"
}
},
"requiredFields": [
"config_change_per_bot_detection_rule",
"namespace"
],
"description": "Minimum configuration for bot_detection_ruleDeployBotDetectionRulesRequest"
},
"fieldMetadata": {
"comments": {
"type": "string",
"description": "Deployment Comments.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config_change_per_bot_detection_rule": {
"type": "array",
"description": "Config change per bot detection rules.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "deployment_status",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-custom-deployments": {
"name": "shape-bot-custom-deployments",
"displayName": "Shape Bot Custom Deployments",
"operations": [
{
"name": "list_shape_bot_custom_deployments",
"description": "GET list of bot detection rule deployments.",
"method": "GET",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/deployments",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "rules_deployment_status",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"bot_detection_rules_deployments": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "bot_detection_rules_deployments",
"type": "array",
"description": "List of bot detection rules deployments."
}
]
},
{
"name": "get_shape_bot_custom_deployment",
"description": "GET details of a bot detection rule deployment.",
"method": "GET",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/deployments/{deployment_id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "deployment_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"config_change_per_bot_detection_rule": {
"type": "array"
},
"deploy_to": {
"type": "array"
},
"deployed_by": {
"type": "string"
},
"deployment_details_per_bot_infra": {
"type": "array"
},
"deployment_time": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "config_change_per_bot_detection_rule",
"type": "array",
"description": "Config change per bot detection rule."
},
{
"field": "deploy_to",
"type": "array",
"description": "Environments to which new rule configuration has to be deployed onto."
},
{
"field": "deployed_by",
"type": "string",
"description": "Deployed By."
},
{
"field": "deployment_details_per_bot_infra",
"type": "array",
"description": "Deployment details per bot infrastructure."
},
{
"field": "deployment_status",
"type": "object",
"description": ""
},
{
"field": "deployment_time",
"type": "string",
"description": "Timestamp at which the deployment was initiated."
}
]
}
]
},
	"shape-bot-custom-draft": {
"name": "shape-bot-custom-draft",
"displayName": "Shape Bot Custom Draft",
"operations": [
{
"name": "delete_shape_bot_custom_draft",
"description": "Discard draft.",
"method": "DELETE",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/draft",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object"
}
},
{
"name": "list_shape_bot_custom_draft",
"description": "GET bot detection rules which are in draft state.",
"method": "GET",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/draft",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"comments": {
"type": "string"
},
"config_change_per_bot_detection_rule": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "comments",
"type": "string",
"description": "Comments"
},
{
"field": "config_change_per_bot_detection_rule",
"type": "array",
"description": "Config change per bot detection rule."
}
]
},
{
"name": "create_shape_bot_custom_draft",
"description": "Save draft.",
"method": "POST",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/draft",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for deploy bot detection rules.",
"title": "DeployBotDetectionRulesRequest",
"x-displayname": "Deploy Bot Detection Rules Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DeployBotDetectionRulesRequest",
"properties": {
"comments": {
"type": "string",
"description": "Deployment Comments.",
"title": "Comments",
"x-displayname": "Comments",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config_change_per_bot_detection_rule": {
"type": "array",
"description": "Config change per bot detection rules.",
"title": "Config Change Per Bot Detection Rules",
"items": {
"$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange"
},
"x-displayname": "Config Change Per Bot Detection Rules.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "namespace",
"minLength": 1,
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+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 bot_detection_ruleDeployBotDetectionRulesRequest",
"required_fields": [
"config_change_per_bot_detection_rule",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_detection_ruleDeployBotDetectionRulesRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  config_change_per_bot_detection_rule: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"config_change_per_bot_detection_rule\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"config_change_per_bot_detection_rule": "value",
"namespace": "value"
}
},
"requiredFields": [
"config_change_per_bot_detection_rule",
"namespace"
],
"description": "Minimum configuration for bot_detection_ruleDeployBotDetectionRulesRequest"
},
"fieldMetadata": {
"comments": {
"type": "string",
"description": "Deployment Comments.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"config_change_per_bot_detection_rule": {
"type": "array",
"description": "Config change per bot detection rules.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"shape-bot-custom-summary": {
"name": "shape-bot-custom-summary",
"displayName": "Shape Bot Custom Summary",
"operations": [
{
"name": "list_shape_bot_custom_summary",
"description": "GET summary of bot detection rules.",
"method": "GET",
"path": "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/summary",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "rule_summary",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-defense-instances": {
"name": "shape-bot-defense-instances",
"displayName": "Shape Bot Defense Instances",
"operations": [
{
"name": "list_shape_bot_defense_instances",
"description": "List Shape Bot Defense Instance.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/shape_bot_defense_instances",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_shape_bot_defense_instance",
"description": "GET Virtual Host.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/shape_bot_defense_instances/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-deployment-history": {
"name": "shape-bot-deployment-history",
"displayName": "Shape Bot Deployment History",
"operations": [
{
"name": "list_shape_bot_deployment_history",
"description": "Deployment History.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/deployment_history",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deployment_history_data": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deployment_history_data",
"type": "array",
"description": "Deployment History Data."
}
]
}
]
},
	"shape-bot-deployment-status": {
"name": "shape-bot-deployment-status",
"displayName": "Shape Bot Deployment Status",
"operations": [
{
"name": "list_shape_bot_deployment_status",
"description": "Deployment Status.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/deployment_status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deployment_data": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deployment_data",
"type": "array",
"description": "Data or content configuration"
}
]
}
]
},
	"shape-bot-download-release-notes": {
"name": "shape-bot-download-release-notes",
"displayName": "Shape Bot Download Release Notes",
"operations": [
{
"name": "list_shape_bot_download_release_notes",
"description": "Download BotDetection Updates Release Notes.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_detection_updates/download_release_notes",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "deployment_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"pre_signed_url": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "pre_signed_url",
"type": "string",
"description": "Pre-Signed URL for the release notes PDF. The expiration of this URL is controlled by config."
}
]
}
]
},
	"shape-bot-endpoint-categories": {
"name": "shape-bot-endpoint-categories",
"displayName": "Shape Bot Endpoint Categories",
"operations": [
{
"name": "create_shape_bot_endpoint_categorie",
"description": "Endpoint Categories.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"endpoint_categories": {
"type": "array"
},
"endpoint_count": {
"type": "string"
},
"event_count": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "endpoint_categories",
"type": "array",
"description": "Endpoint Category Data."
},
{
"field": "endpoint_count",
"type": "string",
"description": "Endpoint or connection point"
},
{
"field": "event_count",
"type": "string",
"description": "Event or occurrence data"
}
]
}
]
},
	"shape-bot-endpoint-list": {
"name": "shape-bot-endpoint-list",
"displayName": "Shape Bot Endpoint List",
"operations": [
{
"name": "create_shape_bot_endpoint_list",
"description": "All Protected Endpoints.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/list",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense expanded traffic overview.",
"title": "TrafficOverviewExpandedRequest",
"x-displayname": "Traffic Overview Expanded Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "100",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense expanded traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewExpandedRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewExpandedRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"endpoints": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewExpandedRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "endpoints",
"type": "array",
"description": "Endpoints Response."
}
]
}
]
},
	"shape-bot-endpoint-summary": {
"name": "shape-bot-endpoint-summary",
"displayName": "Shape Bot Endpoint Summary",
"operations": [
{
"name": "create_shape_bot_endpoint_summary",
"description": "Endpoint Summary.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/summary",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"total_applications": {
"type": "string"
},
"total_distinct_endpoints": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "total_applications",
"type": "string",
"description": "Configuration parameter for total applications"
},
{
"field": "total_distinct_endpoints",
"type": "string",
"description": "The number of distinct endpoints."
}
]
}
]
},
	"shape-bot-endpoints": {
"name": "shape-bot-endpoints",
"displayName": "Shape Bot Endpoints",
"operations": [
{
"name": "create_shape_bot_endpoint",
"description": "Report Endpoints.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"endpoint_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "endpoint_data",
"type": "array",
"description": "Report Endpoints Response."
}
]
}
]
},
	"shape-bot-generate-csr": {
"name": "shape-bot-generate-csr",
"displayName": "Shape Bot Generate Csr",
"operations": [
{
"name": "create_shape_bot_generate_csr",
"description": "Generate CSR.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/generate-csr",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to generate CSR.",
"title": "GenerateCSRRequest",
"x-displayname": "Generate CSR Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.GenerateCSRRequest",
"properties": {
"common_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Common Name",
"minLength": 1,
"x-displayname": "Common Name.",
"x-ves-example": "example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"country_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Country Name",
"minLength": 1,
"x-displayname": "Country Name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"csr_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "CSR Name",
"minLength": 1,
"x-displayname": "CSR Name",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"email": {
"type": "string",
"description": "Email address in RFC 5322 format",
"title": "Email",
"minLength": 1,
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.email": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "dana@example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.email": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"locality": {
"type": "string",
"description": "Configuration parameter for locality",
"title": "Locality",
"minLength": 1,
"x-displayname": "Locality",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"organization_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Organization Name",
"minLength": 1,
"x-displayname": "Organization Name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"organization_unit_name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Organization Unit Name",
"minLength": 1,
"x-displayname": "Organization Unit Name.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"san_main": {
"type": "string",
"description": "Configuration parameter for san main",
"title": "SAN Main",
"minLength": 1,
"x-displayname": "SAN Main",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"san_sub": {
"type": "array",
"title": "SAN Sub",
"items": {
"type": "string"
},
"x-displayname": "SAN Sub",
"description": "Configuration parameter for san sub",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"state": {
"type": "string",
"description": "Current state of the resource",
"title": "State",
"minLength": 1,
"x-displayname": "State",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.min_len": "1"
},
"x-f5xc-example": "running",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for custom_certificateGenerateCSRRequest",
"required_fields": [
"common_name",
"country_name",
"csr_name",
"email",
"locality",
"namespace",
"organization_name",
"organization_unit_name",
"san_main",
"state"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for custom_certificateGenerateCSRRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  common_name: value\n  country_name: value\n  csr_name: value\n  email: value\n  locality: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"common_name\": \"value\",\n    \"country_name\": \"value\",\n    \"csr_name\": \"value\",\n    \"email\": \"value\",\n    \"locality\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"common_name": "value",
"country_name": "value",
"csr_name": "value",
"email": "value",
"locality": "value"
}
},
"requiredFields": [
"common_name",
"country_name",
"csr_name",
"email",
"locality",
"namespace",
"organization_name",
"organization_unit_name",
"san_main",
"state"
],
"description": "Minimum configuration for custom_certificateGenerateCSRRequest"
},
"fieldMetadata": {
"common_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"country_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"csr_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"email": {
"type": "string",
"description": "Email address in RFC 5322 format",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"locality": {
"type": "string",
"description": "Configuration parameter for locality",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"organization_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"organization_unit_name": {
"type": "string",
"description": "Human-readable name for the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"san_main": {
"type": "string",
"description": "Configuration parameter for san main",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"san_sub": {
"type": "array",
"description": "Configuration parameter for san sub",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"state": {
"type": "string",
"description": "Current state of the resource",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "certificate_content",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-history": {
"name": "shape-bot-history",
"displayName": "Shape Bot History",
"operations": [
{
"name": "list_shape_bot_history",
"description": "GET the change history for a bot detection rule.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_detection_rules/{id}/history",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"rule_changes": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "rule_changes",
"type": "array",
"description": "Rule changes holds the details for changes made to a bot detection rule."
}
]
}
]
},
	"shape-bot-insight-credential-stuffing-attack": {
"name": "shape-bot-insight-credential-stuffing-attack",
      "displayName": "Shape Bot Insight Credential Stuffing Attack",
      "operations": [
{
"name": "create_shape_bot_insight_credential_stuffing_attack",
      "description": "Insight Event: Credential Stuffing Attack.",
      "method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/insight/credential-stuffing-attack",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Insight Request.",
"title": "Insight Request",
"x-displayname": "Insight Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightRequest",
"properties": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"title": "Date",
"x-displayname": "Date",
"x-ves-example": "2023/03/01.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "2023/03/01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region": {
"type": "string",
"description": "Region",
"title": "Region",
"x-displayname": "Region",
"x-ves-example": "US",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "US",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingInsightRequest",
"required_fields": [
"date",
"namespace",
"region"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingInsightRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  date: value\n  namespace: value\n  region: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"date\": \"value\",\n    \"namespace\": \"value\",\n    \"region\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bad_bot_login": {
"type": "string"
},
"bad_bot_login_percentage": {
"type": "number"
},
"create_date": {
"type": "number"
},
"mitigated_percentage": {
"type": "number"
},
"time_series": {
"type": "array"
},
"trend": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"date": "value",
"namespace": "value",
"region": "value"
}
},
"requiredFields": [
"date",
"namespace",
"region"
],
"description": "Minimum configuration for reportingInsightRequest"
},
"fieldMetadata": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region": {
"type": "string",
"description": "Region",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bad_bot_login",
"type": "string",
"description": "The Number of Bad Bot Activity with Login Endpoint."
},
{
"field": "bad_bot_login_percentage",
"type": "number",
"description": "The Percentage for Bad Bot Activity with Login Endpoint."
},
{
"field": "create_date",
"type": "number",
"description": "UTC Create Date in seconds."
},
{
"field": "mitigated_percentage",
"type": "number",
"description": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count."
},
{
"field": "time_series",
"type": "array",
"description": "Time Series Graph Data."
},
{
"field": "trend",
"type": "number",
"description": "The Trend of Credential Stuffing Attack."
      }
]
}
]
},
	"shape-bot-insight-event-bad-bot-reduction": {
"name": "shape-bot-insight-event-bad-bot-reduction",
"displayName": "Shape Bot Insight Event Bad Bot Reduction",
"operations": [
{
"name": "create_shape_bot_insight_event_bad_bot_reduction",
"description": "Insight Bad Bot Reduction.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/insight/event/bad-bot-reduction",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Insight Request.",
"title": "Insight Request",
"x-displayname": "Insight Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightRequest",
"properties": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"title": "Date",
"x-displayname": "Date",
"x-ves-example": "2023/03/01.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "2023/03/01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region": {
"type": "string",
"description": "Region",
"title": "Region",
"x-displayname": "Region",
"x-ves-example": "US",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "US",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingInsightRequest",
"required_fields": [
"date",
"namespace",
"region"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingInsightRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  date: value\n  namespace: value\n  region: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"date\": \"value\",\n    \"namespace\": \"value\",\n    \"region\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"create_date": {
"type": "number"
},
"reduction": {
"type": "number"
},
"time_series_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"date": "value",
"namespace": "value",
"region": "value"
}
},
"requiredFields": [
"date",
"namespace",
"region"
],
"description": "Minimum configuration for reportingInsightRequest"
},
"fieldMetadata": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region": {
"type": "string",
"description": "Region",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "create_date",
"type": "number",
"description": "UTC Create Date in seconds."
},
{
"field": "reduction",
"type": "number",
"description": "Reduction"
},
{
"field": "time_series_data",
"type": "array",
"description": "Time Series Data."
}
]
}
]
},
	"shape-bot-insight-event-unaddressed-automations": {
"name": "shape-bot-insight-event-unaddressed-automations",
"displayName": "Shape Bot Insight Event Unaddressed Automations",
"operations": [
{
"name": "create_shape_bot_insight_event_unaddressed_automation",
"description": "Insight Unaddressed Automations.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/insight/event/unaddressed-automations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Insight Request.",
"title": "Insight Request",
"x-displayname": "Insight Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightRequest",
"properties": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"title": "Date",
"x-displayname": "Date",
"x-ves-example": "2023/03/01.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "2023/03/01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region": {
"type": "string",
"description": "Region",
"title": "Region",
"x-displayname": "Region",
"x-ves-example": "US",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "US",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingInsightRequest",
"required_fields": [
"date",
"namespace",
"region"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingInsightRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  date: value\n  namespace: value\n  region: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"date\": \"value\",\n    \"namespace\": \"value\",\n    \"region\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bad_bots": {
"type": "number"
},
"create_date": {
"type": "number"
},
"flagged_endpoints": {
"type": "string"
},
"unaddressed": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"date": "value",
"namespace": "value",
"region": "value"
}
},
"requiredFields": [
"date",
"namespace",
"region"
],
"description": "Minimum configuration for reportingInsightRequest"
},
"fieldMetadata": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region": {
"type": "string",
"description": "Region",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bad_bots",
"type": "number",
"description": "Bad Bots"
},
{
"field": "create_date",
"type": "number",
"description": "UTC Create Date in seconds."
},
{
"field": "flagged_endpoints",
"type": "string",
"description": "Flagged Endpoints."
},
{
"field": "unaddressed",
"type": "number",
"description": "Unaddressed."
}
]
}
]
},
	"shape-bot-insight-personal-stats": {
"name": "shape-bot-insight-personal-stats",
"displayName": "Shape Bot Insight Personal Stats",
"operations": [
{
"name": "create_shape_bot_insight_personal_stat",
"description": "Insight Personal Stats.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/insight/personal-stats",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Insight Request.",
"title": "Insight Request",
"x-displayname": "Insight Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightRequest",
"properties": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"title": "Date",
"x-displayname": "Date",
"x-ves-example": "2023/03/01.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "2023/03/01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region": {
"type": "string",
"description": "Region",
"title": "Region",
"x-displayname": "Region",
"x-ves-example": "US",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "US",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingInsightRequest",
"required_fields": [
"date",
"namespace",
"region"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingInsightRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  date: value\n  namespace: value\n  region: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"date\": \"value\",\n    \"namespace\": \"value\",\n    \"region\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bots": {
"type": "string"
},
"human": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"date": "value",
"namespace": "value",
"region": "value"
}
},
"requiredFields": [
"date",
"namespace",
"region"
],
"description": "Minimum configuration for reportingInsightRequest"
},
"fieldMetadata": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region": {
"type": "string",
"description": "Region",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bots",
"type": "string",
"description": "Configuration parameter for bots"
},
{
"field": "human",
"type": "string",
"description": "Configuration parameter for human"
}
]
}
]
},
	"shape-bot-insight-total-automation": {
"name": "shape-bot-insight-total-automation",
"displayName": "Shape Bot Insight Total Automation",
"operations": [
{
"name": "create_shape_bot_insight_total_automation",
"description": "Insight Event: Total Automation.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/insight/total-automation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Insight Request.",
"title": "Insight Request",
"x-displayname": "Insight Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightRequest",
"properties": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"title": "Date",
"x-displayname": "Date",
"x-ves-example": "2023/03/01.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "2023/03/01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region": {
"type": "string",
"description": "Region",
"title": "Region",
"x-displayname": "Region",
"x-ves-example": "US",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "US",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingInsightRequest",
"required_fields": [
"date",
"namespace",
"region"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingInsightRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  date: value\n  namespace: value\n  region: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"date\": \"value\",\n    \"namespace\": \"value\",\n    \"region\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"automated": {
"type": "string"
},
"automated_percentage": {
"type": "number"
},
"create_date": {
"type": "number"
},
"endpoint": {
"type": "string"
},
"endpoint_label": {
"type": "string"
},
"good_bot": {
"type": "string"
},
"good_bot_percentage": {
"type": "number"
},
"human": {
"type": "string"
},
"human_percentage": {
"type": "number"
},
"malicious_bot": {
"type": "string"
},
"malicious_bot_percentage": {
"type": "number"
},
"mobile": {
"type": "string"
},
"mobile_percentage": {
"type": "number"
},
"others": {
"type": "string"
},
"others_percentage": {
"type": "number"
},
"traffic_channel": {
"type": "string"
},
"web": {
"type": "string"
},
"web_percentage": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"date": "value",
"namespace": "value",
"region": "value"
}
},
"requiredFields": [
"date",
"namespace",
"region"
],
"description": "Minimum configuration for reportingInsightRequest"
},
"fieldMetadata": {
"date": {
"type": "string",
"description": "Date\nFormat: YYYY/MM/DD.",
"constraints": {
"constraintType": "string",
"category": "temporal",
"maxLength": 1024,
"minLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"format": "date",
"formatDescription": "ISO 8601 date (e.g., 2026-01-19)",
"validation": {
"standard": "ISO 8601"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region": {
"type": "string",
"description": "Region",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "automated",
"type": "string",
"description": "Number of HTTP requests identified as automated traffic."
},
{
"field": "automated_percentage",
"type": "number",
"description": "The percentage of the number of automated traffic / the total number."
},
{
"field": "create_date",
"type": "number",
"description": "UTC Create Date in seconds."
},
{
"field": "endpoint",
"type": "string",
"description": "The number of Endpoint."
},
{
"field": "endpoint_label",
"type": "string",
"description": "Endpoint or connection point"
},
{
"field": "good_bot",
"type": "string",
"description": "Number of HTTP requests identified as good bot traffic within specified time interval."
},
{
"field": "good_bot_percentage",
"type": "number",
"description": "The percentage of the number of good bot traffic / the total number."
},
{
"field": "human",
"type": "string",
"description": "Number of HTTP requests identified as human traffic."
},
{
"field": "human_percentage",
"type": "number",
"description": "The percentage of the number of human traffic / the total number."
},
{
"field": "malicious_bot",
"type": "string",
"description": "Number of HTTP requests identified as malicious bot traffic."
},
{
"field": "malicious_bot_percentage",
"type": "number",
"description": "The percentage of the number of malicious bot traffic / the total number."
},
{
"field": "mobile",
"type": "string",
"description": "Number of HTTP requests identified as traffic channel is mobile."
},
{
"field": "mobile_percentage",
"type": "number",
"description": "The percentage of the number of traffic channel:mobile / the total number."
},
{
"field": "others",
"type": "string",
"description": "Number of HTTP requests identified as other traffic within specified time interval."
},
{
"field": "others_percentage",
"type": "number",
"description": "The percentage of the number of others traffic / the total number."
},
{
"field": "traffic_channel",
"type": "string",
"description": "The majority of automated traffic channel."
},
{
"field": "web",
"type": "string",
"description": "Number of HTTP requests identified as traffic channel is web."
},
{
"field": "web_percentage",
"type": "number",
"description": "The percentage of the number of traffic channel:web / the total number."
}
]
}
]
},
	"shape-bot-list-certificate": {
"name": "shape-bot-list-certificate",
"displayName": "Shape Bot List Certificate",
"operations": [
{
"name": "list_shape_bot_list_certificate",
"description": "List Certificates.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/list-certificate",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"certificate": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "certificate",
"type": "array",
"description": "X.509 certificate for TLS"
}
]
}
]
},
	"shape-bot-list-csr": {
"name": "shape-bot-list-csr",
"displayName": "Shape Bot List Csr",
"operations": [
{
"name": "list_shape_bot_list_csr",
"description": "List CSR",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/list-csr",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"csr": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "csr",
"type": "array",
"description": "Configuration parameter for csr"
}
]
}
]
},
	"shape-bot-malicious-endpoints": {
"name": "shape-bot-malicious-endpoints",
"displayName": "Shape Bot Malicious Endpoints",
"operations": [
{
"name": "create_shape_bot_malicious_endpoint",
"description": "Malicious Report Endpoints.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/malicious/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"endpoint_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "endpoint_data",
"type": "array",
"description": "Malicious Report Endpoints Response."
}
]
}
]
},
	"shape-bot-malicious-transactions-asn": {
"name": "shape-bot-malicious-transactions-asn",
"displayName": "Shape Bot Malicious Transactions Asn",
"operations": [
{
"name": "create_shape_bot_malicious_transactions_asn",
"description": "Malicious Report Transactions ASN.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/asn",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-malicious-transactions-browser": {
"name": "shape-bot-malicious-transactions-browser",
"displayName": "Shape Bot Malicious Transactions Browser",
"operations": [
{
"name": "create_shape_bot_malicious_transactions_browser",
"description": "Malicious Report Transactions Browser.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/browser",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-malicious-transactions-ip": {
"name": "shape-bot-malicious-transactions-ip",
"displayName": "Shape Bot Malicious Transactions Ip",
"operations": [
{
"name": "create_shape_bot_malicious_transactions_ip",
"description": "Malicious Report Transactions IP.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ip",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-malicious-transactions-os": {
"name": "shape-bot-malicious-transactions-os",
"displayName": "Shape Bot Malicious Transactions Os",
"operations": [
{
"name": "create_shape_bot_malicious_transactions_o",
"description": "Malicious Report Transactions OS.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/os",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-malicious-transactions-ua": {
"name": "shape-bot-malicious-transactions-ua",
"displayName": "Shape Bot Malicious Transactions Ua",
"operations": [
{
"name": "create_shape_bot_malicious_transactions_ua",
"description": "Malicious Report Transactions UA.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ua",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-policies": {
"name": "shape-bot-policies",
"displayName": "Shape Bot Policies",
"operations": [
{
"name": "create_shape_bot_policie",
"description": "Deploy Policies to Bot Infra.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/policies",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for deploy policies.",
"title": "DeployPolicesRequest",
"x-displayname": "Deploy Policies Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeployPoliciesRequest",
"properties": {
"comments": {
"type": "string",
"description": "The comments for this deployment.",
"title": "Deployed Comments",
"x-displayname": "Comments",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Bot Infra Name.",
"title": "Bot Infra Name",
"minLength": 1,
"x-displayname": "Bot Infrastructure Name.",
"x-ves-example": "Cluster_1",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-example": "cluster_1",
"x-validation-rules": {
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "namespace",
"minLength": 1,
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.string.min_len": "1",
"ves.io.schema.rules.string.ves_object_name": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_metadata": {
"type": "array",
"description": "Deployed Policy Metadata.",
"title": "Deployed Policy Metadata",
"items": {
"$ref": "#/components/schemas/bot_infrastructureDeployPolicyMetadata"
},
"x-displayname": "Deployed Policy.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ti_package_metadata": {
"allOf": [
{
"$ref": "#/components/schemas/bot_infrastructureTIPackageMetadata"
}
],
"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 bot_infrastructureDeployPoliciesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_infrastructureDeployPoliciesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for bot_infrastructureDeployPoliciesRequest"
},
"fieldMetadata": {
"comments": {
"type": "string",
"description": "The comments for this deployment.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Bot Infra Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"policy_metadata": {
"type": "array",
"description": "Deployed Policy Metadata.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ti_package_metadata": {
"type": "object",
"description": "The metadata for TI package, which will be only support for Kubernetes bot infrastructure.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ti_package_metadata.id": {
"type": "string",
"description": "TI Package ID.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ti_package_metadata.name": {
"type": "string",
"description": "TI Package Name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 63,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ti_package_metadata.version": {
"type": "string",
"description": "TI Package Version.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "deploy_status",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "Bot Infra Name."
}
]
}
]
},
	"shape-bot-regions": {
"name": "shape-bot-regions",
"displayName": "Shape Bot Regions",
"operations": [
{
"name": "list_shape_bot_regions",
"description": "Regions",
"method": "GET",
"path": "/api/shape/bot/namespaces/system/regions",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"regions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "regions",
"type": "array",
"description": "List of regions for protected applications."
}
]
}
]
},
	"shape-bot-reporting-endpoint-summary": {
"name": "shape-bot-reporting-endpoint-summary",
"displayName": "Shape Bot Reporting Endpoint Summary",
"operations": [
{
"name": "create_shape_bot_reporting_endpoint_summary",
"description": "Endpoint Summary V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/endpoint/summary",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"total_applications": {
"type": "string"
},
"total_distinct_endpoints": {
"type": "string"
},
"total_unevaluated_transactions": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "total_applications",
"type": "string",
"description": "Configuration parameter for total applications"
},
{
"field": "total_distinct_endpoints",
"type": "string",
"description": "The number of distinct endpoints."
},
{
"field": "total_unevaluated_transactions",
"type": "string",
"description": "Action or operation type"
}
]
}
]
},
	"shape-bot-reporting-forensic-fields": {
"name": "shape-bot-reporting-forensic-fields",
"displayName": "Shape Bot Reporting Forensic Fields",
"operations": [
{
"name": "create_shape_bot_reporting_forensic_field",
"description": "Forensic Fields.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/forensic/fields",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense Forensic Fields.",
"title": "ForensicFieldsRequest",
"x-displayname": "Forensic Fields Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicFieldsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"fields": {
"type": "array",
"description": "Additional fields for the query.",
"title": "Fields",
"items": {
"$ref": "#/components/schemas/reportingForensicField"
},
"x-displayname": "Fields",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Namespace1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "namespace1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense Forensic Fields.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingForensicFieldsRequest",
"required_fields": [
"fields",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingForensicFieldsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  fields: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"fields\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"fields": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"fields": "value",
"namespace": "value"
}
},
"requiredFields": [
"fields",
"namespace"
],
"description": "Minimum configuration for reportingForensicFieldsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"fields": {
"type": "array",
"description": "Additional fields for the query.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "fields",
"type": "array",
"description": "Field specification or configuration"
}
]
}
]
},
	"shape-bot-reporting-malicious-endpoints": {
"name": "shape-bot-reporting-malicious-endpoints",
"displayName": "Shape Bot Reporting Malicious Endpoints",
"operations": [
{
"name": "create_shape_bot_reporting_malicious_endpoint",
"description": "Malicious Report Endpoints V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"endpoint_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "endpoint_data",
"type": "array",
"description": "Malicious Report Endpoints Response."
}
]
}
]
},
	"shape-bot-reporting-malicious-transactions-asn": {
"name": "shape-bot-reporting-malicious-transactions-asn",
"displayName": "Shape Bot Reporting Malicious Transactions Asn",
"operations": [
{
"name": "create_shape_bot_reporting_malicious_transactions_asn",
"description": "Malicious Report Transactions ASN V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/asn",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-reporting-malicious-transactions-browser": {
"name": "shape-bot-reporting-malicious-transactions-browser",
"displayName": "Shape Bot Reporting Malicious Transactions Browser",
"operations": [
{
"name": "create_shape_bot_reporting_malicious_transactions_browser",
"description": "Malicious Report Transactions Browser V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/browser",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-reporting-malicious-transactions-ip": {
"name": "shape-bot-reporting-malicious-transactions-ip",
"displayName": "Shape Bot Reporting Malicious Transactions Ip",
"operations": [
{
"name": "create_shape_bot_reporting_malicious_transactions_ip",
"description": "Malicious Report Transactions IP V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ip",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-reporting-malicious-transactions-os": {
"name": "shape-bot-reporting-malicious-transactions-os",
"displayName": "Shape Bot Reporting Malicious Transactions Os",
"operations": [
{
"name": "create_shape_bot_reporting_malicious_transactions_o",
"description": "Malicious Report Transactions OS V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/os",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-reporting-malicious-transactions-ua": {
"name": "shape-bot-reporting-malicious-transactions-ua",
"displayName": "Shape Bot Reporting Malicious Transactions Ua",
"operations": [
{
"name": "create_shape_bot_reporting_malicious_transactions_ua",
"description": "Malicious Report Transactions UA V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ua",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bot": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bot",
"type": "array",
"description": "Malicious Report Transactions Response."
}
]
}
]
},
	"shape-bot-reporting-peers-check": {
"name": "shape-bot-reporting-peers-check",
"displayName": "Shape Bot Reporting Peers Check",
"operations": [
{
"name": "create_shape_bot_reporting_peers_check",
"description": "Check Peer Status.",
"method": "POST",
"path": "/api/shape/bot/namespaces/system/reporting/peers/check",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Peer Status Request",
"x-displayname": "Request for checking peers status.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerStatusRequest",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingPeerStatusRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingPeerStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"has_peers": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for reportingPeerStatusRequest"
},
"responseSummary": [
{
"field": "has_peers",
"type": "boolean",
"description": "The tenat has peers or not."
}
]
}
]
},
	"shape-bot-reporting-peers-threat-types": {
"name": "shape-bot-reporting-peers-threat-types",
"displayName": "Shape Bot Reporting Peers Threat Types",
"operations": [
{
"name": "create_shape_bot_reporting_peers_threat_type",
"description": "Peergroup By Threat Types.",
"method": "POST",
"path": "/api/shape/bot/reporting/peers/threat-types",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"title": "PeerGroupRequest",
"x-displayname": "Peer Group Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"title": "Rankby",
"x-displayname": "Rank by",
"x-ves-example": "Self",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"x-f5xc-example": "self",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"enum": [
"self",
"peer"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingPeerGroupRequest",
"required_fields": [
"end_time",
"rank_by",
"start_time"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingPeerGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  end_time: value\n  rank_by: value\n  start_time: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"end_time\": \"value\",\n    \"rank_by\": \"value\",\n    \"start_time\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"details": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"end_time": "value",
"rank_by": "value",
"start_time": "value"
}
},
"requiredFields": [
"end_time",
"rank_by",
"start_time"
],
"description": "Minimum configuration for reportingPeerGroupRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "details",
"type": "array",
"description": "Configuration parameter for details"
}
]
}
]
},
	"shape-bot-reporting-peers-top-good-bots": {
"name": "shape-bot-reporting-peers-top-good-bots",
"displayName": "Shape Bot Reporting Peers Top Good Bots",
"operations": [
{
"name": "create_shape_bot_reporting_peers_top_good_bot",
"description": "Peer Group Top Good Bots.",
"method": "POST",
"path": "/api/shape/bot/reporting/peers/top-good-bots",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"title": "PeerGroupRequest",
"x-displayname": "Peer Group Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"title": "Rankby",
"x-displayname": "Rank by",
"x-ves-example": "Self",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"x-f5xc-example": "self",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"enum": [
"self",
"peer"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingPeerGroupRequest",
"required_fields": [
"end_time",
"rank_by",
"start_time"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingPeerGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  end_time: value\n  rank_by: value\n  start_time: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"end_time\": \"value\",\n    \"rank_by\": \"value\",\n    \"start_time\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"details": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"end_time": "value",
"rank_by": "value",
"start_time": "value"
}
},
"requiredFields": [
"end_time",
"rank_by",
"start_time"
],
"description": "Minimum configuration for reportingPeerGroupRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "details",
"type": "array",
"description": "Configuration parameter for details"
}
]
}
]
},
	"shape-bot-reporting-peers-top-reason-codes": {
"name": "shape-bot-reporting-peers-top-reason-codes",
"displayName": "Shape Bot Reporting Peers Top Reason Codes",
"operations": [
{
"name": "create_shape_bot_reporting_peers_top_reason_code",
"description": "Peergroup Top Reason Codes.",
"method": "POST",
"path": "/api/shape/bot/reporting/peers/top-reason-codes",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"title": "PeerGroupRequest",
"x-displayname": "Peer Group Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"title": "Rankby",
"x-displayname": "Rank by",
"x-ves-example": "Self",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"x-f5xc-example": "self",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"enum": [
"self",
"peer"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingPeerGroupRequest",
"required_fields": [
"end_time",
"rank_by",
"start_time"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingPeerGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  end_time: value\n  rank_by: value\n  start_time: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"end_time\": \"value\",\n    \"rank_by\": \"value\",\n    \"start_time\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"details": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"end_time": "value",
"rank_by": "value",
"start_time": "value"
}
},
"requiredFields": [
"end_time",
"rank_by",
"start_time"
],
"description": "Minimum configuration for reportingPeerGroupRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "details",
"type": "array",
"description": "Configuration parameter for details"
}
]
}
]
},
	"shape-bot-reporting-peers-traffic-overview": {
"name": "shape-bot-reporting-peers-traffic-overview",
"displayName": "Shape Bot Reporting Peers Traffic Overview",
"operations": [
{
"name": "create_shape_bot_reporting_peers_traffic_overview",
"description": "Peer Group Traffic Overview.",
"method": "POST",
"path": "/api/shape/bot/reporting/peers/traffic/overview",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"title": "PeerGroupRequest",
"x-displayname": "Peer Group Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"title": "End time",
"format": "date-time",
"x-displayname": "End Time",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"title": "Rankby",
"x-displayname": "Rank by",
"x-ves-example": "Self",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"x-f5xc-example": "self",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]"
},
"enum": [
"self",
"peer"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"title": "Start time",
"format": "date-time",
"x-displayname": "Start Time.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense Peer Group Peer Benchmarking.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingPeerGroupRequest",
"required_fields": [
"end_time",
"rank_by",
"start_time"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingPeerGroupRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  end_time: value\n  rank_by: value\n  start_time: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"end_time\": \"value\",\n    \"rank_by\": \"value\",\n    \"start_time\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"details": {
"type": "array"
},
"peer_percentage": {
"type": "number"
},
"peer_total": {
"type": "string"
},
"self_percentage": {
"type": "number"
},
"self_total": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"end_time": "value",
"rank_by": "value",
"start_time": "value"
}
},
"requiredFields": [
"end_time",
"rank_by",
"start_time"
],
"description": "Minimum configuration for reportingPeerGroupRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"rank_by": {
"type": "string",
"description": "Rank by self or peer.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "details",
"type": "array",
"description": "Configuration parameter for details"
},
{
"field": "peer_percentage",
"type": "number",
"description": "The Peer Percentage of the Item."
},
{
"field": "peer_total",
"type": "string",
"description": "The total number of Peer of the Item."
},
{
"field": "self_percentage",
"type": "number",
"description": "The Self Percentage of the Item."
},
{
"field": "self_total",
"type": "string",
"description": "The total number of Self of the item."
}
]
}
]
},
	"shape-bot-reporting-top-type-good": {
"name": "shape-bot-reporting-top-type-good",
"displayName": "Shape Bot Reporting Top Type Good",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_good",
"description": "Top Good Bots V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/good",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"good_bots": {
"type": "array"
},
"top_good_bots_percentage": {
"type": "number"
},
"total_good_bots": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "good_bots",
"type": "array",
"description": "Top good bots."
},
{
"field": "top_good_bots_percentage",
"type": "number",
"description": "Top Good Bots Count / Total Good Bots Count."
},
{
"field": "total_good_bots",
"type": "string",
"description": "Total Good Bots Traffic Count."
}
]
}
]
},
	"shape-bot-reporting-top-type-human-dimension-browser": {
"name": "shape-bot-reporting-top-type-human-dimension-browser",
"displayName": "Shape Bot Reporting Top Type Human Dimension Browser",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_human_dimension_browser",
"description": "Top Human Browser V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/browser",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_browser_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_browser_data",
"type": "array",
"description": "Top Human Browser Response."
}
]
}
]
},
	"shape-bot-reporting-top-type-human-dimension-device": {
"name": "shape-bot-reporting-top-type-human-dimension-device",
"displayName": "Shape Bot Reporting Top Type Human Dimension Device",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_human_dimension_device",
"description": "Top Human Device V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/device",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_device_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_device_data",
"type": "array",
"description": "Top Human Device Response."
}
]
}
]
},
	"shape-bot-reporting-top-type-human-dimension-geolocation": {
"name": "shape-bot-reporting-top-type-human-dimension-geolocation",
"displayName": "Shape Bot Reporting Top Type Human Dimension Geolocation",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_human_dimension_geolocation",
"description": "Top Human Geolocation V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/geolocation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_geolocation_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_geolocation_data",
"type": "array",
"description": "Top Human Geolocation Response."
}
]
}
]
},
	"shape-bot-reporting-top-type-human-dimension-platform": {
"name": "shape-bot-reporting-top-type-human-dimension-platform",
"displayName": "Shape Bot Reporting Top Type Human Dimension Platform",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_human_dimension_platform",
"description": "Top Human Platform V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/platform",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_platform_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_platform_data",
"type": "array",
"description": "Top Human Platform Response."
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-apps-timeseries": {
"name": "shape-bot-reporting-top-type-malicious-dimension-apps-timeseries",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Apps Timeseries",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_apps_timeserie",
"description": "Malicious Report APP Time Series V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/apps/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"app_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "app_data",
"type": "array",
"description": "App Data"
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-asorg": {
"name": "shape-bot-reporting-top-type-malicious-dimension-asorg",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Asorg",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_asorg",
"description": "Top ASN of Attack Intent V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/asorg/{attack_type}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "attack_type",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots by attack intent.",
"title": "Request for Top  Malicious Bot Events of Sources by Attack Intent",
"x-displayname": "Request for Top Malicious Bot Events of Sources by Attack Intent Type.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequestAttackIntent",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "AccountCreation.",
"x-f5xc-example": "AccountCreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.",
"x-f5xc-description-medium": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for top malicious bots by attack intent.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequestAttackIntent",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequestAttackIntent\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bad_bot_asn_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequestAttackIntent"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bad_bot_asn_data",
"type": "array",
"description": "The list of top source by ASN."
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-attackintent": {
"name": "shape-bot-reporting-top-type-malicious-dimension-attackintent",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Attackintent",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_attackintent",
"description": "Top Malicious Bots by Attack Intent V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/attackintent",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attack_intents": {
"type": "array"
},
"total": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attack_intents",
"type": "array",
"description": "Configuration parameter for attack intents"
},
{
"field": "total",
"type": "string",
"description": "Total Events."
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-automation": {
"name": "shape-bot-reporting-top-type-malicious-dimension-automation",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Automation",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_automation",
"description": "Top Malicious Bot Automation Types v3.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/automation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"automation_types": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "automation_types",
"type": "array",
"description": "Top malicious bot automation types."
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-endpoints": {
"name": "shape-bot-reporting-top-type-malicious-dimension-endpoints",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Endpoints",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_endpoint",
"description": "Top Attacked Endpoints v3.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attacked_endpoints": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attacked_endpoints",
"type": "array",
"description": "Top attacked application endpoints."
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-ip": {
"name": "shape-bot-reporting-top-type-malicious-dimension-ip",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Ip",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_ip",
"description": "Top Source IP of Attack Intent V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ip/{attack_type}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "attack_type",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots by attack intent.",
"title": "Request for Top  Malicious Bot Events of Sources by Attack Intent",
"x-displayname": "Request for Top Malicious Bot Events of Sources by Attack Intent Type.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequestAttackIntent",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "AccountCreation.",
"x-f5xc-example": "AccountCreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.",
"x-f5xc-description-medium": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for top malicious bots by attack intent.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequestAttackIntent",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequestAttackIntent\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bad_bot_ip_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequestAttackIntent"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bad_bot_ip_data",
"type": "array",
"description": "The list of top source by source IP."
}
]
}
]
},
	"shape-bot-reporting-top-type-malicious-dimension-ua": {
"name": "shape-bot-reporting-top-type-malicious-dimension-ua",
"displayName": "Shape Bot Reporting Top Type Malicious Dimension Ua",
"operations": [
{
"name": "create_shape_bot_reporting_top_type_malicious_dimension_ua",
"description": "Top User Agent of Attack Intent V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ua/{attack_type}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "attack_type",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots by attack intent.",
"title": "Request for Top  Malicious Bot Events of Sources by Attack Intent",
"x-displayname": "Request for Top Malicious Bot Events of Sources by Attack Intent Type.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequestAttackIntent",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "AccountCreation.",
"x-f5xc-example": "AccountCreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.",
"x-f5xc-description-medium": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for top malicious bots by attack intent.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequestAttackIntent",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequestAttackIntent\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bad_bot_ua_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequestAttackIntent"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bad_bot_ua_data",
"type": "array",
"description": "The list of top source by UA."
}
]
}
]
},
	"shape-bot-reporting-traffic-automated-overview-actions": {
"name": "shape-bot-reporting-traffic-automated-overview-actions",
"displayName": "Shape Bot Reporting Traffic Automated Overview Actions",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_automated_overview_action",
"description": "Automated Traffic Overview in actions.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/automated/overview/actions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"actions": {
"type": "array"
},
"current_total": {
"type": "string"
},
"previous_total": {
"type": "string"
},
"sentiment": {
"type": "string"
},
"trend": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "actions",
"type": "array",
"description": "Action or operation type"
},
{
"field": "current_total",
"type": "string",
"description": "The total count of all the action taken."
},
{
"field": "previous_total",
"type": "string",
"description": "The total number of automated bot traffic in the action taken within the previous specified time interval."
},
{
"field": "sentiment",
"type": "string",
"description": "The sentiment for the total automated bot traffic Actions."
},
{
"field": "trend",
"type": "number",
"description": "Trend of the number of automated bot traffic in the Action Taken."
}
]
}
]
},
	"shape-bot-reporting-traffic-known-active-ai": {
"name": "shape-bot-reporting-traffic-known-active-ai",
"displayName": "Shape Bot Reporting Traffic Known Active Ai",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_active_ai",
"description": "Active AI Known Bot.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/active/ai",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"active_ai_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "active_ai_bots",
"type": "array",
"description": "Active AI Bots."
}
]
}
]
},
	"shape-bot-reporting-traffic-known-dimension-category": {
"name": "shape-bot-reporting-traffic-known-dimension-category",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_dimension_category",
"description": "Known Bot Transactions Per Category.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"known_bot_category_distribution": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "known_bot_category_distribution",
"type": "array",
"description": "Known Bot Category Distribution."
}
]
}
]
},
	"shape-bot-reporting-traffic-known-dimension-category-actions": {
"name": "shape-bot-reporting-traffic-known-dimension-category-actions",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category Actions",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_dimension_category_action",
"description": "Known Bot Actions Per Category.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/actions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"action_taken_summary": {
"type": "array"
},
"category_action_breakdown": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "action_taken_summary",
"type": "array",
"description": "Action Taken Summary."
},
{
"field": "category_action_breakdown",
"type": "array",
"description": "Category Action Breakdown."
}
]
}
]
},
	"shape-bot-reporting-traffic-known-dimension-category-actions-ai": {
"name": "shape-bot-reporting-traffic-known-dimension-category-actions-ai",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category Actions Ai",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_dimension_category_actions_ai",
"description": "Known Bot Actions Per AI Category.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/actions/ai",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"action_taken_summary": {
"type": "array"
},
"category_action_breakdown": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "action_taken_summary",
"type": "array",
"description": "Action Taken Summary."
},
{
"field": "category_action_breakdown",
"type": "array",
"description": "Category Action Breakdown."
}
]
}
]
},
	"shape-bot-reporting-traffic-known-dimension-category-timeseries": {
"name": "shape-bot-reporting-traffic-known-dimension-category-timeseries",
"displayName": "Shape Bot Reporting Traffic Known Dimension Category Timeseries",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_dimension_category_timeserie",
"description": "Known Bot Categories Over Time.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"known_bot_category_time_series_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "known_bot_category_time_series_data",
"type": "array",
"description": "Transactions per known bot category over time distribution."
}
]
}
]
},
	"shape-bot-reporting-traffic-known-dimension-endpoint": {
"name": "shape-bot-reporting-traffic-known-dimension-endpoint",
"displayName": "Shape Bot Reporting Traffic Known Dimension Endpoint",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_dimension_endpoint",
"description": "Known Bot Endpoint.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/endpoint",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"known_bot_endpoints": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "known_bot_endpoints",
"type": "array",
"description": "Known Bot Endpoints."
},
{
"field": "pagination",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-reporting-traffic-known-statistics-overview": {
"name": "shape-bot-reporting-traffic-known-statistics-overview",
"displayName": "Shape Bot Reporting Traffic Known Statistics Overview",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_known_statistics_overview",
"description": "Known Bot Overview Statistics.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/statistics/overview",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"distinct_ai_bots": {
"type": "string"
},
"distinct_ai_bots_sentiment": {
"type": "string"
},
"distinct_ai_bots_trend": {
"type": "number"
},
"distinct_categories": {
"type": "string"
},
"distinct_categories_sentiment": {
"type": "string"
},
"distinct_categories_trend": {
"type": "number"
},
"distinct_known_bots": {
"type": "string"
},
"distinct_known_bots_sentiment": {
"type": "string"
},
"distinct_known_bots_trend": {
"type": "number"
},
"total_ai_transactions": {
"type": "string"
},
"total_ai_transactions_sentiment": {
"type": "string"
},
"total_ai_transactions_trend": {
"type": "number"
},
"total_distinct_ai_bots": {
"type": "string"
},
"total_distinct_categories": {
"type": "string"
},
"total_distinct_known_bots": {
"type": "string"
},
"total_transactions": {
"type": "string"
},
"total_transactions_sentiment": {
"type": "string"
},
"total_transactions_trend": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "distinct_ai_bots",
"type": "string",
"description": "Distinct AI bot entities observed in the selected time range."
},
{
"field": "distinct_ai_bots_sentiment",
"type": "string",
"description": "Trend sentiment indicator for distinct AI bots."
},
{
"field": "distinct_ai_bots_trend",
"type": "number",
"description": "Percentage change of distinct AI bots versus the previous period."
},
{
"field": "distinct_categories",
"type": "string",
"description": "Distinct known-bot categories observed in the selected time range."
},
{
"field": "distinct_categories_sentiment",
"type": "string",
"description": "Trend sentiment indicator for distinct categories."
},
{
"field": "distinct_categories_trend",
"type": "number",
"description": "Percentage change of distinct categories versus the previous period."
},
{
"field": "distinct_known_bots",
"type": "string",
"description": "Distinct known bot entities observed in the selected time range."
},
{
"field": "distinct_known_bots_sentiment",
"type": "string",
"description": "Trend sentiment indicator for distinct known bots."
},
{
"field": "distinct_known_bots_trend",
"type": "number",
"description": "Percentage change of distinct known bots versus the previous period."
},
{
"field": "total_ai_transactions",
"type": "string",
"description": "Total AI bot transactions in the selected time range."
},
{
"field": "total_ai_transactions_sentiment",
"type": "string",
"description": "Trend sentiment indicator for AI bot transactions."
},
{
"field": "total_ai_transactions_trend",
"type": "number",
"description": "Percentage change of AI bot transactions versus the previous period."
},
{
"field": "total_distinct_ai_bots",
"type": "string",
"description": "Total distinct AI bot count."
},
{
"field": "total_distinct_categories",
"type": "string",
"description": "Total distinct known-bot category count."
},
{
"field": "total_distinct_known_bots",
"type": "string",
"description": "Total distinct known bot count."
},
{
"field": "total_transactions",
"type": "string",
"description": "Total known bot transactions in the selected time range."
},
{
"field": "total_transactions_sentiment",
"type": "string",
"description": "Trend sentiment indicator for total transactions."
},
{
"field": "total_transactions_trend",
"type": "number",
"description": "Percentage change of total known bot transactions versus the previous period."
}
]
}
]
},
	"shape-bot-reporting-traffic-malicious-dimension-attackintent-timeseries": {
"name": "shape-bot-reporting-traffic-malicious-dimension-attackintent-timeseries",
"displayName": "Shape Bot Reporting Traffic Malicious Dimension Attackintent Timeseries",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_malicious_dimension_attackintent_timeserie",
"description": "Malicious Bot Attack Intent Time Series V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/dimension/attackintent/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attack_intent_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attack_intent_data",
"type": "array",
"description": "Data or content configuration"
}
]
}
]
},
	"shape-bot-reporting-traffic-malicious-overview-actions": {
"name": "shape-bot-reporting-traffic-malicious-overview-actions",
"displayName": "Shape Bot Reporting Traffic Malicious Overview Actions",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_malicious_overview_action",
"description": "Malicious Traffic Overview in actions V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/actions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"actions": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "actions",
"type": "array",
"description": "Action or operation type"
}
]
}
]
},
	"shape-bot-reporting-traffic-malicious-overview-metrics": {
"name": "shape-bot-reporting-traffic-malicious-overview-metrics",
"displayName": "Shape Bot Reporting Traffic Malicious Overview Metrics",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_malicious_overview_metric",
"description": "Malicious Traffic Overview Metrics V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"ASN": {
"type": "string"
},
"BFP": {
"type": "string"
},
"HFP": {
"type": "string"
},
"IP": {
"type": "string"
},
"UFP": {
"type": "string"
},
"user_agent": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "ASN",
"type": "string",
"description": "Configuration parameter for ASN"
},
{
"field": "BFP",
"type": "string",
"description": "Configuration parameter for BFP"
},
{
"field": "HFP",
"type": "string",
"description": "Configuration parameter for HFP"
},
{
"field": "IP",
"type": "string",
"description": "Configuration parameter for IP"
},
{
"field": "UFP",
"type": "string",
"description": "Configuration parameter for UFP"
},
{
"field": "user_agent",
"type": "string",
"description": "User Agent."
}
]
}
]
},
	"shape-bot-reporting-traffic-malicious-overview-timeseries-actions": {
"name": "shape-bot-reporting-traffic-malicious-overview-timeseries-actions",
"displayName": "Shape Bot Reporting Traffic Malicious Overview Timeseries Actions",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_malicious_overview_timeseries_action",
"description": "Malicious Traffic Overview Timeseries in Actions V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/timeseries/actions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"values": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "values",
"type": "array",
"description": "Maclicious Traffic Overview Timeseries in Actions."
}
]
}
]
},
	"shape-bot-reporting-traffic-overview": {
"name": "shape-bot-reporting-traffic-overview",
"displayName": "Shape Bot Reporting Traffic Overview",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_overview",
"description": "Traffic Overview V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"bot_trend": {
"type": "number"
},
"good_bot": {
"type": "string"
},
"good_bot_percentage": {
"type": "number"
},
"good_bot_previous": {
"type": "string"
},
"good_bot_sentiment": {
"type": "string"
},
"good_bot_trend": {
"type": "number"
},
"human": {
"type": "string"
},
"human_percentage": {
"type": "number"
},
"human_previous": {
"type": "string"
},
"human_sentiment": {
"type": "string"
},
"human_trend": {
"type": "number"
},
"malicious_bot": {
"type": "string"
},
"malicious_bot_percentage": {
"type": "number"
},
"malicious_bot_previous": {
"type": "string"
},
"malicious_bot_sentiment": {
"type": "string"
},
"others": {
"type": "string"
},
"others_percentage": {
"type": "number"
},
"others_previous": {
"type": "string"
},
"others_trend": {
"type": "number"
},
"total": {
"type": "string"
},
"total_previous": {
"type": "string"
},
"total_sentiment": {
"type": "string"
},
"total_trend": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "bot_trend",
"type": "number",
"description": "Trend of the number of HTTP requests identified as bot traffic."
},
{
"field": "good_bot",
"type": "string",
"description": "Number of HTTP requests identified as good bot traffic within specified time interval."
},
{
"field": "good_bot_percentage",
"type": "number",
"description": "The percentage of the number of good bot traffic / the total number."
},
{
"field": "good_bot_previous",
"type": "string",
"description": "Number of HTTP requests identified as good bot traffic within the previous specified time interval."
},
{
"field": "good_bot_sentiment",
"type": "string",
"description": "The sentiment for the trend of good bot traffic."
},
{
"field": "good_bot_trend",
"type": "number",
"description": "Trend of the number of HTTP requests identified as good bot traffic."
},
{
"field": "human",
"type": "string",
"description": "Number of HTTP requests identified as human traffic within specified time interval."
},
{
"field": "human_percentage",
"type": "number",
"description": "The percentage of the number of human traffic / the total number."
},
{
"field": "human_previous",
"type": "string",
"description": "Number of HTTP requests identified as human traffic within the previous specified time interval."
},
{
"field": "human_sentiment",
"type": "string",
"description": "The sentiment for the trend of human traffic."
},
{
"field": "human_trend",
"type": "number",
"description": "Trend of the number of HTTP requests identified as human traffic."
},
{
"field": "malicious_bot",
"type": "string",
"description": "Number of HTTP requests identified as malicious bot traffic within specified time interval."
},
{
"field": "malicious_bot_percentage",
"type": "number",
"description": "The percentage of the number of malicious bot traffic / the total number."
},
{
"field": "malicious_bot_previous",
"type": "string",
"description": "Number of HTTP requests identified as malicious bot traffic within the previous specified time interval."
},
{
"field": "malicious_bot_sentiment",
"type": "string",
"description": "The sentiment for the trend of malicious bot traffic."
},
{
"field": "others",
"type": "string",
"description": "Number of HTTP requests identified as other traffic within specified time interval."
},
{
"field": "others_percentage",
"type": "number",
"description": "The percentage of the number of others traffic / the total number."
},
{
"field": "others_previous",
"type": "string",
"description": "Number of HTTP requests identified as other traffic within the previous specified time interval."
},
{
"field": "others_trend",
"type": "number",
"description": "Trend of the number of HTTP requests identified as other traffic."
},
{
"field": "total",
"type": "string",
"description": "Total number of HTTP requests within specified time interval."
},
{
"field": "total_previous",
"type": "string",
"description": "Total number of HTTP requests within the previous specified time interval."
},
{
"field": "total_sentiment",
"type": "string",
"description": "The sentiment for the trend of total traffic."
},
{
"field": "total_trend",
"type": "number",
"description": "Trend of the total number of HTTP requests."
}
]
}
]
},
	"shape-bot-reporting-traffic-overview-expanded": {
"name": "shape-bot-reporting-traffic-overview-expanded",
"displayName": "Shape Bot Reporting Traffic Overview Expanded",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_overview_expanded",
"description": "Expanded Traffic Overview V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/expanded",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense expanded traffic overview.",
"title": "TrafficOverviewExpandedRequest",
"x-displayname": "Traffic Overview Expanded Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "100",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense expanded traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewExpandedRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewExpandedRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"total_transactions": {
"type": "string"
},
"transactions": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewExpandedRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "total_transactions",
"type": "string",
"description": "Total number of traffic transactions."
},
{
"field": "transactions",
"type": "array",
"description": "A list of traffic transactions."
}
]
}
]
},
	"shape-bot-reporting-traffic-overview-timeseries": {
"name": "shape-bot-reporting-traffic-overview-timeseries",
"displayName": "Shape Bot Reporting Traffic Overview Timeseries",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_overview_timeserie",
"description": "Traffic Overview Timeseries V2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"values": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "values",
"type": "array",
"description": "Traffic overview timeseries."
}
]
}
]
},
	"shape-bot-reporting-traffic-top-type-known-active": {
"name": "shape-bot-reporting-traffic-top-type-known-active",
"displayName": "Shape Bot Reporting Traffic Top Type Known Active",
"operations": [
{
"name": "create_shape_bot_reporting_traffic_top_type_known_active",
"description": "Top Active Known Bot.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/top/type/known/active",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Known Bot Request.",
"title": "Known Bot Request",
"x-displayname": "Known Bot Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingGlobalFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"pagination": {
"allOf": [
{
"$ref": "#/components/schemas/reportingPagination"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"title": "Request Metrics",
"items": {
"type": "string"
},
"x-displayname": "Request Metrics.",
"x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"title": "Sort Option",
"items": {
"$ref": "#/components/schemas/reportingSortOption"
},
"x-displayname": "Sort",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "title": "Time Bucket Size",
"x-displayname": "Time Bucket Size.",
"x-ves-example": "PT1H",
"x-f5xc-example": "PT1H",
"x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.",
"x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingKnownBotRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingKnownBotRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"top_known_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for reportingKnownBotRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Query Global Filters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.global_filters": {
"type": "array",
"description": "List of global filters.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination": {
"type": "object",
"description": "Pagination with number and size.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"pagination.page_number": {
"type": "integer",
"description": "Configuration parameter for page number",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"pagination.page_size": {
"type": "integer",
"description": "Size or capacity specification",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 500,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"request_metrics": {
"type": "array",
"description": "Optional, list of metric identifiers to retrieve.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_options": {
"type": "array",
"description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"time_bucket_size": {
"type": "string",
"description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "top_known_bots",
"type": "array",
"description": "Top Known Bots."
}
]
}
]
},
	"shape-bot-rollback-certificate-to-default": {
"name": "shape-bot-rollback-certificate-to-default",
"displayName": "Shape Bot Rollback Certificate To Default",
"operations": [
{
"name": "replace_shape_bot_rollback_certificate_to_default",
"description": "Rollback Certificate To Default.",
"method": "PUT",
"path": "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/rollback-certificate-to-default",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for rollback certificate to default.",
"title": "RollbackCertificateToDefaultRequest",
"x-displayname": "Rollback Certificate To Default Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.RollbackCertificateToDefaultRequest",
"properties": {
"name": {
"type": "string",
"description": "Bot Infrastructure Name.",
"title": "Bot Infrastructure Name",
"x-displayname": "Bot Infrastructure Name.",
"x-ves-example": "Cluster_1",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "cluster_1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "default",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region_list": {
"type": "array",
"description": "List of regions for rollback.",
"title": "Region List",
"minItems": 1,
"maxItems": 32,
"items": {
"$ref": "#/components/schemas/bot_defensebot_infrastructureLocation"
},
"x-displayname": "Region List.",
"x-ves-example": "[US_EAST_1, US_WEST_1]",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.max_items": "32",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "[US_EAST_1, US_WEST_1]",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.max_items": "32",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for rollback certificate to default.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for bot_infrastructureRollbackCertificateToDefaultRequest",
"required_fields": [
"name",
"namespace",
"region_list"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for bot_infrastructureRollbackCertificateToDefaultRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  region_list: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"region_list\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"region_list": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"region_list": "value"
}
},
"requiredFields": [
"name",
"namespace",
"region_list"
],
"description": "Minimum configuration for bot_infrastructureRollbackCertificateToDefaultRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Bot Infrastructure Name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"region_list": {
"type": "array",
"description": "List of regions for rollback.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "name",
"type": "string",
"description": "Name of the cluster."
},
{
"field": "region_list",
"type": "array",
"description": "List of region status for certificate operation."
}
]
}
]
},
	"shape-bot-subscribe": {
"name": "shape-bot-subscribe",
"displayName": "Shape Bot Subscribe",
"operations": [
{
"name": "create_shape_bot_subscribe",
"description": "Subscribe to Shape Bot Defense.",
"method": "POST",
"path": "/api/shape/bot/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Shape Bot Defense.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-oneof-field-tier": "[\"standard\"]",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.SubscribeRequest",
"properties": {
"standard": {
"allOf": [
{
"$ref": "#/components/schemas/schemaEmpty"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to subscribe to Shape Bot Defense.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
},
"fieldMetadata": {
"standard": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"tier": [
"standard"
]
}
}
]
},
	"shape-bot-template": {
"name": "shape-bot-template",
"displayName": "Shape Bot Template",
"operations": [
{
"name": "list_shape_bot_template",
"description": "Template Connector.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/protected_applications/{name}/template",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"template": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "name",
"type": "string",
"description": "IApp template connector file name."
},
{
"field": "template",
"type": "string",
"description": "IApp template connector."
}
]
}
]
},
	"shape-bot-top-endpoints": {
"name": "shape-bot-top-endpoints",
"displayName": "Shape Bot Top Endpoints",
"operations": [
{
"name": "create_shape_bot_top_endpoint",
"description": "Top Attacked Endpoints.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attacked_endpoints": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attacked_endpoints",
"type": "array",
"description": "Top attacked application endpoints."
}
]
}
]
},
	"shape-bot-top-latency-overview": {
"name": "shape-bot-top-latency-overview",
"displayName": "Shape Bot Top Latency Overview",
"operations": [
{
"name": "create_shape_bot_top_latency_overview",
"description": "Top Latency Overview.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"average_latency": {
"type": "string"
},
"critical": {
"type": "string"
},
"high": {
"type": "string"
},
"low": {
"type": "string"
},
"previous_latency": {
"type": "string"
},
"sentiment": {
"type": "string"
},
"trend": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "average_latency",
"type": "string",
"description": "Average latency."
},
{
"field": "critical",
"type": "string",
"description": "Critical"
},
{
"field": "high",
"type": "string",
"description": "Configuration parameter for high"
},
{
"field": "low",
"type": "string",
"description": "Configuration parameter for low"
},
{
"field": "previous_latency",
"type": "string",
"description": "Previous latency."
},
{
"field": "sentiment",
"type": "string",
"description": "Sentiment"
},
{
"field": "trend",
"type": "number",
"description": "Configuration parameter for trend"
}
]
}
]
},
	"shape-bot-top-latency-overview-apps": {
"name": "shape-bot-top-latency-overview-apps",
"displayName": "Shape Bot Top Latency Overview Apps",
"operations": [
{
"name": "create_shape_bot_top_latency_overview_app",
"description": "Top Latency Overview Apps.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview/apps",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"applications": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "applications",
"type": "array",
"description": "Top Latency Overview Apps."
}
]
}
]
},
	"shape-bot-top-malicious-asorg": {
"name": "shape-bot-top-malicious-asorg",
"displayName": "Shape Bot Top Malicious Asorg",
"operations": [
{
"name": "create_shape_bot_top_malicious_asorg",
"description": "Top Malicious Bots by ASOrg.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/asorg",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bots",
"type": "array",
"description": "The list of top malicious bots by AS Organizations."
}
]
}
]
},
	"shape-bot-top-malicious-automation": {
"name": "shape-bot-top-malicious-automation",
"displayName": "Shape Bot Top Malicious Automation",
"operations": [
{
"name": "create_shape_bot_top_malicious_automation",
"description": "Top Malicious Bot Automation Types.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/automation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"automation_types": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "automation_types",
"type": "array",
"description": "Top malicious bot automation types."
}
]
}
]
},
	"shape-bot-top-malicious-ip": {
"name": "shape-bot-top-malicious-ip",
"displayName": "Shape Bot Top Malicious Ip",
"operations": [
{
"name": "create_shape_bot_top_malicious_ip",
"description": "Top Malicious Bots by IP address.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ip",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bots",
"type": "array",
"description": "The list of top malicious bots by source IP."
}
]
}
]
},
	"shape-bot-top-malicious-ua": {
"name": "shape-bot-top-malicious-ua",
"displayName": "Shape Bot Top Malicious Ua",
"operations": [
{
"name": "create_shape_bot_top_malicious_ua",
"description": "Top Malicious Bots by User Agent String.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ua",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bots",
"type": "array",
"description": "The list of top malicious bots by User Agent String."
}
]
}
]
},
	"shape-bot-top-transactions-app": {
"name": "shape-bot-top-transactions-app",
"displayName": "Shape Bot Top Transactions App",
"operations": [
{
"name": "create_shape_bot_top_transactions_app",
"description": "Top Transactions by Application.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/app",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"application_data": {
"type": "array"
},
"total_applications": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "application_data",
"type": "array",
"description": "The list of top transactions by application."
},
{
"field": "total_applications",
"type": "string",
"description": "Configuration parameter for total applications"
}
]
}
]
},
	"shape-bot-top-transactions-categories": {
"name": "shape-bot-top-transactions-categories",
"displayName": "Shape Bot Top Transactions Categories",
"operations": [
{
"name": "create_shape_bot_top_transactions_categorie",
"description": "Top Categories.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/categories",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"categories": {
"type": "array"
},
"total_requests": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "categories",
"type": "array",
"description": "Requests sorted by flow label categories over a requested period of time (as time series)"
},
{
"field": "total_requests",
"type": "string",
"description": "Total number of requests for requested period."
}
]
}
]
},
	"shape-bot-top-transactions-endpointlabels": {
"name": "shape-bot-top-transactions-endpointlabels",
"displayName": "Shape Bot Top Transactions Endpointlabels",
"operations": [
{
"name": "create_shape_bot_top_transactions_endpointlabel",
"description": "Top Endpoint Labels.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/endpointlabels",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"endpoint_labels": {
"type": "array"
},
"total_requests": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "endpoint_labels",
"type": "array",
"description": "Over a time period."
},
{
"field": "total_requests",
"type": "string",
"description": "Total number of requests."
}
]
}
]
},
	"shape-bot-top-type-good": {
"name": "shape-bot-top-type-good",
"displayName": "Shape Bot Top Type Good",
"operations": [
{
"name": "create_shape_bot_top_type_good",
"description": "Top Good Bots.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/good",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"good_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "good_bots",
"type": "array",
"description": "Top good bots."
}
]
}
]
},
	"shape-bot-top-type-human-dimension-browser": {
"name": "shape-bot-top-type-human-dimension-browser",
"displayName": "Shape Bot Top Type Human Dimension Browser",
"operations": [
{
"name": "create_shape_bot_top_type_human_dimension_browser",
"description": "Top Human Browser.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/browser",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_browser_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_browser_data",
"type": "array",
"description": "Top Human Browser Response."
}
]
}
]
},
	"shape-bot-top-type-human-dimension-device": {
"name": "shape-bot-top-type-human-dimension-device",
"displayName": "Shape Bot Top Type Human Dimension Device",
"operations": [
{
"name": "create_shape_bot_top_type_human_dimension_device",
"description": "Top Human Device.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/device",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_device_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_device_data",
"type": "array",
"description": "Top Human Device Response."
}
]
}
]
},
	"shape-bot-top-type-human-dimension-geolocation": {
"name": "shape-bot-top-type-human-dimension-geolocation",
"displayName": "Shape Bot Top Type Human Dimension Geolocation",
"operations": [
{
"name": "create_shape_bot_top_type_human_dimension_geolocation",
"description": "Top Human Geolocation.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/geolocation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_geolocation_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_geolocation_data",
"type": "array",
"description": "Top Human Geolocation Response."
}
]
}
]
},
	"shape-bot-top-type-human-dimension-platform": {
"name": "shape-bot-top-type-human-dimension-platform",
"displayName": "Shape Bot Top Type Human Dimension Platform",
"operations": [
{
"name": "create_shape_bot_top_type_human_dimension_platform",
"description": "Top Human Platform.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/platform",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human_platform_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human_platform_data",
"type": "array",
"description": "Top Human Platform Response."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-app": {
"name": "shape-bot-top-type-malicious-dimension-app",
"displayName": "Shape Bot Top Type Malicious Dimension App",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_app",
"description": "Top Malicious Bots by Application.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/app",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"application_data": {
"type": "array"
},
"total_applications": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "application_data",
"type": "array",
"description": "The list of top malicious bots by application."
},
{
"field": "total_applications",
"type": "string",
"description": "Configuration parameter for total applications"
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-apps-timeseries": {
"name": "shape-bot-top-type-malicious-dimension-apps-timeseries",
"displayName": "Shape Bot Top Type Malicious Dimension Apps Timeseries",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_apps_timeserie",
"description": "Malicious Report APP Time Series.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/apps/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"app_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "app_data",
"type": "array",
"description": "App Data"
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-asorg": {
"name": "shape-bot-top-type-malicious-dimension-asorg",
"displayName": "Shape Bot Top Type Malicious Dimension Asorg",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_asorg",
"description": "Top Malicious Bots by ASOrg v2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bots",
"type": "array",
"description": "The list of top malicious bots by AS Organizations."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-attackintent": {
"name": "shape-bot-top-type-malicious-dimension-attackintent",
"displayName": "Shape Bot Top Type Malicious Dimension Attackintent",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_attackintent",
"description": "Top Malicious Bots by Attack Intent.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/attackintent",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attack_intents": {
"type": "array"
},
"total": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attack_intents",
"type": "array",
"description": "Configuration parameter for attack intents"
},
{
"field": "total",
"type": "string",
"description": "Total Events."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-automation": {
"name": "shape-bot-top-type-malicious-dimension-automation",
"displayName": "Shape Bot Top Type Malicious Dimension Automation",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_automation",
"description": "Top Malicious Bot Automation Types v2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/automation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"automation_types": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "automation_types",
"type": "array",
"description": "Top malicious bot automation types."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-bfp": {
"name": "shape-bot-top-type-malicious-dimension-bfp",
"displayName": "Shape Bot Top Type Malicious Dimension Bfp",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_bfp",
"description": "Top Attacked BFP.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/bfp",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attacked_bfp": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attacked_bfp",
"type": "array",
"description": "Top Attacked BFP."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-endpoints": {
"name": "shape-bot-top-type-malicious-dimension-endpoints",
"displayName": "Shape Bot Top Type Malicious Dimension Endpoints",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_endpoint",
"description": "Top Attacked Endpoints v2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/endpoints",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attacked_endpoints": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attacked_endpoints",
"type": "array",
"description": "Top attacked application endpoints."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-ip": {
"name": "shape-bot-top-type-malicious-dimension-ip",
"displayName": "Shape Bot Top Type Malicious Dimension Ip",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_ip",
"description": "Top Malicious Bots by IP address v2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bots",
"type": "array",
"description": "The list of top malicious bots by source IP."
}
]
}
]
},
	"shape-bot-top-type-malicious-dimension-ua": {
"name": "shape-bot-top-type-malicious-dimension-ua",
"displayName": "Shape Bot Top Type Malicious Dimension Ua",
"operations": [
{
"name": "create_shape_bot_top_type_malicious_dimension_ua",
"description": "Top Malicious Bots by User Agent String v2.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"malicious_bots": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "malicious_bots",
"type": "array",
"description": "The list of top malicious bots by User Agent String."
}
]
}
]
},
	"shape-bot-traffic-dimension-attackintent-timeseries": {
"name": "shape-bot-traffic-dimension-attackintent-timeseries",
"displayName": "Shape Bot Traffic Dimension Attackintent Timeseries",
"operations": [
{
"name": "create_shape_bot_traffic_dimension_attackintent_timeserie",
"description": "Attack Intent Time Series For All Traffic.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/attackintent/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attack_intent_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attack_intent_data",
"type": "array",
"description": "Data or content configuration"
}
]
}
]
},
	"shape-bot-traffic-dimension-categories-timeseries": {
"name": "shape-bot-traffic-dimension-categories-timeseries",
"displayName": "Shape Bot Traffic Dimension Categories Timeseries",
"operations": [
{
"name": "create_shape_bot_traffic_dimension_categories_timeserie",
"description": "Categories Time Series For All Traffic.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/categories/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"category_time_series_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "category_time_series_data",
"type": "array",
"description": "Data or content configuration"
}
]
}
]
},
	"shape-bot-traffic-malicious-dimension-attackintent-timeseries": {
"name": "shape-bot-traffic-malicious-dimension-attackintent-timeseries",
"displayName": "Shape Bot Traffic Malicious Dimension Attackintent Timeseries",
"operations": [
{
"name": "create_shape_bot_traffic_malicious_dimension_attackintent_timeserie",
"description": "Malicious Bot Attack Intent Time Series.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/dimension/attackintent/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"attack_intent_data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "attack_intent_data",
"type": "array",
"description": "Data or content configuration"
}
]
}
]
},
	"shape-bot-traffic-malicious-overview-actions": {
"name": "shape-bot-traffic-malicious-overview-actions",
"displayName": "Shape Bot Traffic Malicious Overview Actions",
"operations": [
{
"name": "create_shape_bot_traffic_malicious_overview_action",
"description": "Malicious Traffic Overview in actions.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/actions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"flagged_count": {
"type": "string"
},
"flagged_percentage": {
"type": "number"
},
"flagged_previous": {
"type": "string"
},
"flagged_sentiment": {
"type": "string"
},
"flagged_trend": {
"type": "number"
},
"mitigated_count": {
"type": "string"
},
"mitigated_percentage": {
"type": "number"
},
"mitigated_previous": {
"type": "string"
},
"mitigated_sentiment": {
"type": "string"
},
"mitigated_trend": {
"type": "number"
},
"total": {
"type": "string"
},
"unknown_count": {
"type": "string"
},
"unknown_percentage": {
"type": "number"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "flagged_count",
"type": "string",
"description": "The total number of malicious bot traffic in flagged."
},
{
"field": "flagged_percentage",
"type": "number",
"description": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count."
},
{
"field": "flagged_previous",
"type": "string",
"description": "The total number of malicious bot traffic in flagged within the previous specified time interval."
},
{
"field": "flagged_sentiment",
"type": "string",
"description": "The sentiment for the trend of malicious traffic in flagged."
},
{
"field": "flagged_trend",
"type": "number",
"description": "Trend of the number of malicious bot traffic in flagged."
},
{
"field": "mitigated_count",
"type": "string",
"description": "The total number of malicious bot traffic in mitigated."
},
{
"field": "mitigated_percentage",
"type": "number",
"description": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count."
},
{
"field": "mitigated_previous",
"type": "string",
"description": "The total number of malicious bot traffic in mitigated within the previous specified time interval."
},
{
"field": "mitigated_sentiment",
"type": "string",
"description": "The sentiment for the trend of malicious traffic in mitigated."
},
{
"field": "mitigated_trend",
"type": "number",
"description": "Trend of the number of malicious bot traffic in mitigated."
},
{
"field": "total",
"type": "string",
"description": "The total number of malicious bot traffic."
},
{
"field": "unknown_count",
"type": "string",
"description": "The total number of malicious bot traffic in Unknown."
},
{
"field": "unknown_percentage",
"type": "number",
"description": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count."
}
]
}
]
},
	"shape-bot-traffic-malicious-overview-metrics": {
"name": "shape-bot-traffic-malicious-overview-metrics",
"displayName": "Shape Bot Traffic Malicious Overview Metrics",
"operations": [
{
"name": "create_shape_bot_traffic_malicious_overview_metric",
"description": "Malicious Traffic Overview Metrics.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for top malicious bots.",
"title": "TopRequest",
"x-displayname": "Request for Top Malicious Bots.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest",
"properties": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"title": "Attack Intent Type",
"x-displayname": "Attack Intent Type.",
"x-ves-example": "Accountcreation.",
"x-f5xc-example": "accountcreation",
"x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gt": "0",
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...",
"x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTopRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTopRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"ASN": {
"type": "string"
},
"BFP": {
"type": "string"
},
"HFP": {
"type": "string"
},
"IP": {
"type": "string"
},
"UFP": {
"type": "string"
},
"user_agent": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTopRequest"
},
"fieldMetadata": {
"attack_type": {
"type": "string",
"description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope traffic overview query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "ASN",
"type": "string",
"description": "Configuration parameter for ASN"
},
{
"field": "BFP",
"type": "string",
"description": "Configuration parameter for BFP"
},
{
"field": "HFP",
"type": "string",
"description": "Configuration parameter for HFP"
},
{
"field": "IP",
"type": "string",
"description": "Configuration parameter for IP"
},
{
"field": "UFP",
"type": "string",
"description": "Configuration parameter for UFP"
},
{
"field": "user_agent",
"type": "string",
"description": "User Agent."
}
]
}
]
},
	"shape-bot-traffic-malicious-overview-timeseries-actions": {
"name": "shape-bot-traffic-malicious-overview-timeseries-actions",
"displayName": "Shape Bot Traffic Malicious Overview Timeseries Actions",
"operations": [
{
"name": "create_shape_bot_traffic_malicious_overview_timeseries_action",
"description": "Malicious Traffic Overview Timeseries in Actions.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/timeseries/actions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"values": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "values",
"type": "array",
"description": "Maclicious Traffic Overview Timeseries in Actions."
}
]
}
]
},
	"shape-bot-traffic-overview": {
"name": "shape-bot-traffic-overview",
"displayName": "Shape Bot Traffic Overview",
"operations": [
{
"name": "create_shape_bot_traffic_overview",
"description": "Traffic Overview.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"human": {
"type": "string"
},
"malicious_bot": {
"type": "string"
},
"total": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "human",
"type": "string",
"description": "Number of HTTP requests identified as human traffic within specified time interval."
},
{
"field": "malicious_bot",
"type": "string",
"description": "Number of HTTP requests identified as malicious bot traffic within specified time interval."
},
{
"field": "total",
"type": "string",
"description": "Total number of HTTP requests within specified time interval."
}
]
}
]
},
	"shape-bot-traffic-overview-expanded": {
"name": "shape-bot-traffic-overview-expanded",
"displayName": "Shape Bot Traffic Overview Expanded",
"operations": [
{
"name": "create_shape_bot_traffic_overview_expanded",
"description": "Expanded Traffic Overview.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/expanded",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense expanded traffic overview.",
"title": "TrafficOverviewExpandedRequest",
"x-displayname": "Traffic Overview Expanded Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-example": "100",
"x-validation-rules": {
"ves.io.schema.rules.uint32.lte": "500"
},
"x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...",
"x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense expanded traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewExpandedRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewExpandedRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"total_transactions": {
"type": "string"
},
"transactions": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewExpandedRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 500,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "total_transactions",
"type": "string",
"description": "Total number of traffic transactions."
},
{
"field": "transactions",
"type": "array",
"description": "A list of traffic transactions."
}
]
}
]
},
	"shape-bot-traffic-overview-timeseries": {
"name": "shape-bot-traffic-overview-timeseries",
"displayName": "Shape Bot Traffic Overview Timeseries",
"operations": [
{
"name": "create_shape_bot_traffic_overview_timeserie",
"description": "Traffic Overview Timeseries.",
"method": "POST",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/timeseries",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Shape Bot Defense traffic overview.",
"title": "TrafficOverviewRequest",
"x-displayname": "Traffic Overview Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest",
"properties": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"title": "Category",
"x-displayname": "Category",
"x-ves-example": "Login",
"x-f5xc-example": "Login",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-f5xc-example": "1570197600",
"x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/reportingFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-f5xc-example": "1570194000",
"x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...",
"x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"title": "Use raw data",
"format": "boolean",
"x-displayname": "Use raw data.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Example-app-vh-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "example-app-vh-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Name of Virtual Host to scope the query.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for reportingTrafficOverviewRequest",
"required_fields": [
"namespace",
"virtual_host"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for reportingTrafficOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value\n  virtual_host: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\",\n    \"virtual_host\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"values": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value",
"virtual_host": "value"
}
},
"requiredFields": [
"namespace",
"virtual_host"
],
"description": "Minimum configuration for reportingTrafficOverviewRequest"
},
"fieldMetadata": {
"category": {
"type": "string",
"description": "Endpoint category label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "Reporting API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken": {
"type": "object",
"description": "Query Filter by action taken.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.action_taken.actions_taken": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.action_taken.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.app_id_filter": {
"type": "object",
"description": "Query Filter by app ID filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.app_id_filter.app_id_strings": {
"type": "array",
"description": "An unordered list of App ID strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.app_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.application_name": {
"type": "object",
"description": "Query Filter by application name.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.application_name.application_names": {
"type": "array",
"description": "A list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.application_name.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.as_org_filter": {
"type": "object",
"description": "Query Filter by AS Organizations.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.as_org_filter.as_orgs": {
"type": "array",
"description": "An unordered list of as org strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.as_org_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.attack_intent_filter": {
"type": "object",
"description": "Query Filter by attack intent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.attack_intent_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.attack_intent_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.automation_type_filter": {
"type": "object",
"description": "Query Filter by automation type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.automation_type_filter.automation_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.automation_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.browser_filter": {
"type": "object",
"description": "Query Filter by browser filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.browser_filter.browser_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.browser_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.country_filter": {
"type": "object",
"description": "Query Filter by country filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.country_filter.country_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.country_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.host_filter": {
"type": "object",
"description": "Query Filter by host filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.host_filter.host_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.host_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.inference_filter": {
"type": "object",
"description": "Query Filter by Inference filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.inference_filter.inference_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.inference_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ip_filter": {
"type": "object",
"description": "Query Filter by IP addresses.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ip_filter.ips": {
"type": "array",
"description": "An unordered list of IPv4 addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"minItems": 0,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ip_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.method_filter": {
"type": "object",
"description": "Query Filter by traffic method strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.method_filter.method_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.method_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter": {
"type": "object",
"description": "Query Filter by OS filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.os_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.os_filter.os_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.referer_filter": {
"type": "object",
"description": "Query Filter by referer filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.referer_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.referer_filter.referer_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.region_filter": {
"type": "string",
"description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "US"
},
"filters.traffic_type_filter": {
"type": "object",
"description": "Query Filter by traffic type filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.traffic_type_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.traffic_type_filter.traffic_type_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.ua_filter": {
"type": "object",
"description": "Query Filter by user agent filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.ua_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.ua_filter.ua_strings": {
"type": "array",
"description": "An unordered list of user agent strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.uri_filter": {
"type": "object",
"description": "Query Filter by URI filter strings.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.uri_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.uri_filter.uri_strings": {
"type": "array",
"description": "An list of strings.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"use_raw_data": {
"type": "boolean",
"description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"virtual_host": {
"type": "string",
"description": "Name of Virtual Host to scope the query.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "values",
"type": "array",
"description": "Traffic overview timeseries."
}
]
}
]
},
	"shape-bot-unarchive": {
"name": "shape-bot-unarchive",
"displayName": "Shape Bot Unarchive",
"operations": [
{
"name": "replace_shape_bot_unarchive",
"description": "Unarchive Certificate By ID.",
"method": "PUT",
"path": "/api/shape/bot/namespaces/{namespace}/certificate/{cert_id}/unarchive",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "cert_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to unarchive certificate by ID.",
"title": "UnarchiveCertificateByIDRequest",
"x-displayname": "Unarchive Certificate By ID Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.UnarchiveCertificateByIDRequest",
"properties": {
"cert_id": {
"type": "string",
"description": "Unique identifier for this resource",
"title": "Certificate ID",
"x-displayname": "Certificate ID.",
"x-ves-example": "65b73012a44742000137f379.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "65b73012a44742000137f379",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for custom_certificateUnarchiveCertificateByIDRequest",
"required_fields": [
"cert_id",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for custom_certificateUnarchiveCertificateByIDRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  cert_id: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"cert_id\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"cert_id": "value",
"namespace": "value"
}
},
"requiredFields": [
"cert_id",
"namespace"
],
"description": "Minimum configuration for custom_certificateUnarchiveCertificateByIDRequest"
},
"fieldMetadata": {
"cert_id": {
"type": "string",
"description": "Unique identifier for this resource",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "certificate_detail",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-unsubscribe": {
"name": "shape-bot-unsubscribe",
"displayName": "Shape Bot Unsubscribe",
"operations": [
{
"name": "create_shape_bot_unsubscribe",
"description": "Unsubscribe to Shape Bot Defense.",
"method": "POST",
"path": "/api/shape/bot/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Shape Bot Defense.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to Shape Bot Defense.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"shape-bot-usage-summary": {
"name": "shape-bot-usage-summary",
"displayName": "Shape Bot Usage Summary",
"operations": [
{
"name": "list_shape_bot_usage_summary",
"description": "Usage Summary.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/reporting/usage/summary",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"records": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "records",
"type": "array",
"description": "Per month usage summary data."
}
]
}
]
},
	"shape-bot-versions": {
"name": "shape-bot-versions",
"displayName": "Shape Bot Versions",
"operations": [
{
"name": "list_shape_bot_versions",
"description": "Bot Allowlist Policy Versions.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policy/{name}/versions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"policy_versions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "policy_versions",
"type": "array",
"description": "Policy Versions."
}
]
},
{
"name": "get_shape_bot_version",
"description": "GET Content.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys/{name}/versions/{number}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "number",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "allowlist_policy_content",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-bot-versions-mobile-base-config": {
"name": "shape-bot-versions-mobile-base-config",
"displayName": "Shape Bot Versions Mobile Base Config",
"operations": [
{
"name": "get_shape_bot_versions_mobile_base_config",
"description": "GET Mobile Base Configuration File.",
"method": "GET",
"path": "/api/shape/bot/namespaces/{namespace}/bot_endpoint_policy/{name}/versions/{number}/mobile_base_config/{os}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "number",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "os",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "content",
"type": "string",
"description": "Mobile SDK Base Configuration content."
},
{
"field": "name",
"type": "string",
"description": "Mobile SDK Base Configuration file name."
}
]
}
]
},
	"shape-csd": {
"name": "shape-csd",
"displayName": "Shape Csd",
"operations": [
{
"name": "create_shape_csd",
"description": "Create Allowed Domain.",
"method": "POST",
"path": "/api/shape/csd/namespaces/{namespace}/allowed_domains",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of allowed_domain",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/allowed_domainCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for allowed_domainCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for allowed_domainCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for allowed_domainCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create allowed domain.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_domain": {
"type": "string",
"description": "Enter root domain or domain to be entered to allow list below.\nDomains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.\nExample: if you are adding Client-Side Defense JS on checkout.example.com, you should enter example.com here.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "list_shape_csd",
"description": "List Client-Side Defense Allowed Domain.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/allowed_domains",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_shape_csd",
"description": "DELETE Client-Side Defense Allowed Domain.",
"method": "DELETE",
"path": "/api/shape/csd/namespaces/{namespace}/allowed_domains/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a allowed_domain",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for allowed_domainDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for allowed_domainDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_shape_csd",
"description": "GET Allowed Domain.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/allowed_domains/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-csd-affectedUsers": {
"name": "shape-csd-affectedUsers",
"displayName": "Shape Csd Affectedusers",
"operations": [
{
"name": "create_shape_csd_affectedUser",
"description": "List Affected Users.",
"method": "POST",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/affectedUsers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "script_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to list affected users who have loaded this particular script.",
"title": "ListAffectedUsersRequest",
"x-displayname": "List Affected Users Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListAffectedUsersRequest",
"properties": {
"end_time": {
"type": "string",
"description": "Format: unix epoch timestamp in seconds\nfetch affected users whose last seen time <= end_time.",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "1570194300.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194300",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch affected users whose last seen time <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters": {
"allOf": [
{
"$ref": "#/components/schemas/client_side_defenseAffectedUserFilters"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"page_number": {
"type": "integer",
"description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.",
      "title": "page_number",
"format": "int32",
"x-displayname": "Page Number.",
"x-ves-example": "10",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "1"
},
"x-f5xc-example": "10",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "1"
},
"x-f5xc-description-short": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.",
      "x-f5xc-description-medium": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.",
      "x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"page_size": {
"type": "integer",
"description": "The maximum number of affected users to return per page.",
"title": "page_size",
"format": "int32",
"x-displayname": "Page Size",
"x-ves-example": "500",
"x-ves-validation-rules": {
"ves.io.schema.rules.uint32.gte": "1",
"ves.io.schema.rules.uint32.lte": "1000"
},
"x-f5xc-example": "500",
"x-validation-rules": {
"ves.io.schema.rules.uint32.gte": "1",
"ves.io.schema.rules.uint32.lte": "1000"
},
"x-f5xc-description-short": "The maximum number of affected users to return per page.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"page_token": {
      "type": "string",
"description": "Page_token is the value of listaffectedusersresponse.next_page_token from previous request.",
      "title": "page_token",
      "maxLength": 512,
"x-displayname": "Page Token.",
      "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "512"
},
"x-f5xc-example": "cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "512"
},
"x-f5xc-description-short": "Page_token is the value of listaffectedusersresponse.next_page_token from previous request.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"script_id": {
"type": "string",
"description": "ID of the script.",
"title": "script_id",
"x-displayname": "Script ID",
"x-ves-example": "S-1234567",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "s-1234567",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"sorts": {
"type": "array",
"description": "Additional sort criteria.",
"title": "sorts",
"items": {
"$ref": "#/components/schemas/client_side_defenseSort"
},
"x-displayname": "Sorts",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Format: unix epoch timestamp in seconds\nfetch affected users whose last seen time >= start_time.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch affected users whose last seen time >= start_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to list affected users who have loaded this particular script.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for client_side_defenseListAffectedUsersRequest",
"required_fields": [
"end_time",
"script_id",
"start_time"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for client_side_defenseListAffectedUsersRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  end_time: value\n  script_id: value\n  start_time: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"end_time\": \"value\",\n    \"script_id\": \"value\",\n    \"start_time\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"affected_users": {
"type": "array"
},
"next_page_token": {
      "type": "string"
},
"page_number": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total_count": {
"type": "integer"
},
"total_pages": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"end_time": "value",
"script_id": "value",
"start_time": "value"
}
},
"requiredFields": [
"end_time",
"script_id",
"start_time"
],
"description": "Minimum configuration for client_side_defenseListAffectedUsersRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "Format: unix epoch timestamp in seconds\nfetch affected users whose last seen time <= end_time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters": {
"type": "object",
"description": "ListAffectedUsers API query filters.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.affected_user_device_id_filter": {
"type": "object",
"description": "Filter by affected user device ID.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.affected_user_device_id_filter.device_ids": {
"type": "array",
"description": "An unordered list of device IDs.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.affected_user_device_id_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.affected_user_geolocation_filter": {
"type": "object",
"description": "Filter by affected user geolocation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.affected_user_geolocation_filter.geolocations": {
"type": "array",
"description": "An unordered list of geolocations.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.affected_user_geolocation_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"filters.affected_user_ip_address_filter": {
"type": "object",
"description": "Filter by affected user IP address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters.affected_user_ip_address_filter.ip_addresses": {
"type": "array",
"description": "An unordered list of IP addresses.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filters.affected_user_ip_address_filter.op": {
"type": "string",
"description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IN"
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"page_number": {
"type": "integer",
"description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"page_size": {
"type": "integer",
"description": "The maximum number of affected users to return per page.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 1000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"page_token": {
      "type": "string",
"description": "Page_token is the value of listaffectedusersresponse.next_page_token from previous request.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"script_id": {
"type": "string",
"description": "ID of the script.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"sorts": {
"type": "array",
"description": "Additional sort criteria.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Format: unix epoch timestamp in seconds\nfetch affected users whose last seen time >= start_time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "affected_users",
"type": "array",
"description": "List of affected users."
},
{
"field": "next_page_token",
      "type": "string",
"description": "Opaque value passed back alone with the additional calls. All filtering will stay the same."
},
{
"field": "page_number",
"type": "integer",
"description": "One-indexed page number."
},
{
"field": "page_size",
"type": "integer",
"description": "The maximum number of affected users to return per page."
},
{
"field": "total_count",
"type": "integer",
"description": "Total count of affected users available at time of query, and subject to change across queries."
},
{
"field": "total_pages",
"type": "integer",
"description": "Total number of pages available depending upon requested page_size."
}
]
}
]
},
	"shape-csd-analysis": {
"name": "shape-csd-analysis",
"displayName": "Shape Csd Analysis",
"operations": [
{
"name": "create_shape_csd_analysi",
"description": "Update FormField Analysis.",
"method": "POST",
"path": "/api/shape/csd/namespaces/{namespace}/formFields/analysis",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to PATCH analysis of fields across scripts.",
"title": "UpdateFieldAnalysisRequest",
"x-displayname": "Update Field Analysis request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateFieldAnalysisRequest",
"properties": {
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "name",
"x-displayname": "Form Field Name.",
"x-ves-example": "Username",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-example": "Username",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.not_empty": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/client_side_defenseANALYSIS_TYPE"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to PATCH analysis of fields across scripts.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for client_side_defenseUpdateFieldAnalysisRequest",
"required_fields": [
"name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for client_side_defenseUpdateFieldAnalysisRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value"
}
},
"requiredFields": [
"name"
],
"description": "Minimum configuration for client_side_defenseUpdateFieldAnalysisRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"type": {
"type": "string",
"description": "Type of Analysis\n\n- SENSITIVE: SENSITIVE\nMark field as sensitive\n- NOT_SENSITIVE: NOT_SENSITIVE\nMark field as not sensitive.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SENSITIVE"
}
},
"responseSummary": [
{
"field": "status",
"type": "string",
"description": "Values: not_modified , success\nStatus about field analysis status modification."
}
]
}
]
},
	"shape-csd-approval-status": {
"name": "shape-csd-approval-status",
"displayName": "Shape Csd Approval Status",
"operations": [
{
"name": "create_shape_csd_approval_statu",
"description": "Update Script Approval Status.",
"method": "POST",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{id}/approval-status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update script approval status.",
"title": "UpdateScriptApprovalStatusRequest",
"x-displayname": "Update Script Approval Status Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptApprovalStatusRequest",
"properties": {
"id": {
"type": "string",
"description": "Script ID",
"title": "id",
"x-displayname": "Script ID",
"x-ves-example": "S-ssAH-Ji-oC.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-example": "s-ssAH-Ji-oC",
"x-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/client_side_defenseScriptApprovalStatus"
}
],
"x-f5xc-example": "active",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to update script approval status.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for client_side_defenseUpdateScriptApprovalStatusRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for client_side_defenseUpdateScriptApprovalStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"script_id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for client_side_defenseUpdateScriptApprovalStatusRequest"
},
"fieldMetadata": {
"id": {
"type": "string",
"description": "Script ID",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"status": {
"type": "string",
"description": "Type of Script Approval Status\n\n- UNKNOWN: UNKNOWN\nUnknown approval status - default value\n- APPROVED: APPROVED\nScript is approved\n- REJECTED: REJECTED\nScript is rejected.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNKNOWN"
}
},
"responseSummary": [
{
"field": "script_id",
"type": "string",
"description": "ID of the script that was updated."
}
]
}
]
},
	"shape-csd-behaviors": {
"name": "shape-csd-behaviors",
"displayName": "Shape Csd Behaviors",
"operations": [
{
"name": "list_shape_csd_behaviors",
"description": "List Behaviors By Script.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{id}/behaviors",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"behaviors": {
"type": "array"
},
"total_size": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "behaviors",
"type": "array",
"description": "List of behaviors depending upon filter."
},
{
"field": "total_size",
"type": "integer",
"description": "Total size of scripts."
}
]
}
]
},
	"shape-csd-dashboard": {
"name": "shape-csd-dashboard",
"displayName": "Shape Csd Dashboard",
"operations": [
{
"name": "list_shape_csd_dashboard",
"description": "GET Script Overview.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{id}/dashboard",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"events": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "events",
"type": "array",
"description": "Event info of the dashboard of the script."
},
{
"field": "summary",
"type": "object",
"description": ""
}
]
}
]
},
	"shape-csd-formFields": {
"name": "shape-csd-formFields",
"displayName": "Shape Csd Formfields",
"operations": [
{
"name": "list_shape_csd_formFields",
"description": "List Form Fields By Script.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{id}/formFields",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"form_fields": {
"type": "array"
},
"status": {
"type": "string"
},
"total_size": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "form_fields",
"type": "array",
"description": "List of form fields for input script depending on start time and end time."
},
{
"field": "status",
"type": "string",
"description": "Status of the script."
},
{
"field": "total_size",
"type": "integer",
"description": "Total size of scripts."
}
]
}
]
},
	"shape-csd-init": {
"name": "shape-csd-init",
"displayName": "Shape Csd Init",
"operations": [
{
"name": "create_shape_csd_init",
"description": "Enable Client-Side Defense.",
"method": "POST",
"path": "/api/shape/csd/namespaces/system/init",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Provision API.",
      "title": "InitRequest",
"x-displayname": "Enable Client-Side Defense Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.InitRequest",
"properties": {
"email": {
"type": "string",
"description": "Email Address for Notifications.",
"title": "Email Address for Notifications",
"x-displayname": "Email Address for Notifications.",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.email": "true",
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.email": "true",
"ves.io.schema.rules.string.not_empty": "true"
},
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"serviceType": {
"type": "string",
"description": "CSD service type.",
"title": "Service Type",
"x-displayname": "Service Type.",
"x-ves-example": "Csd-service.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.in": "[\\\"csd-service\\\"]"
},
"x-f5xc-example": "csd-service",
"x-validation-rules": {
"ves.io.schema.rules.string.in": "[\\\"csd-service\\\"]"
},
"enum": [
"csd-service"
],
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Provision API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for client_side_defenseInitRequest",
"required_fields": [
"email"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for client_side_defenseInitRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  email: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"email\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"isConfigured": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"email": "value"
}
},
"requiredFields": [
"email"
],
"description": "Minimum configuration for client_side_defenseInitRequest"
},
"fieldMetadata": {
"email": {
"type": "string",
"description": "Email Address for Notifications.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"serviceType": {
"type": "string",
"description": "CSD service type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "isConfigured",
"type": "boolean",
"description": "Client-Side defense service is configured."
}
]
}
]
},
	"shape-csd-inline": {
"name": "shape-csd-inline",
"displayName": "Shape Csd Inline",
"operations": [
{
"name": "list_shape_csd_inline",
"description": "List Inline Scripts.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/inline",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "script_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"scripts": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "scripts",
"type": "array",
"description": "List of inline scripts with hash values."
}
]
}
]
},
	"shape-csd-justification": {
"name": "shape-csd-justification",
"displayName": "Shape Csd Justification",
"operations": [
{
"name": "delete_shape_csd_justification",
"description": "DELETE Script Justification.",
"method": "DELETE",
"path": "/api/shape/csd/namespaces/{namespace}/script/justification/{justification_id}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "justification_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object"
}
},
{
"name": "create_shape_csd_justification",
"description": "Update Script Justification.",
"method": "POST",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/justification",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "script_id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update script justification.",
"title": "UpdateScriptJustificationRequest",
"x-displayname": "Update script justification request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptJustificationRequest",
"properties": {
"justification": {
"type": "string",
"description": "Script Justification.",
"title": "justification",
"x-displayname": "Script Justification.",
"x-ves-example": "Blocking script due to network callout to malicious domain.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "Blocking script due to network callout to malicious domain.",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"script_id": {
"type": "string",
"description": "ID of the script.",
"title": "script_id",
"x-displayname": "Script ID",
"x-ves-example": "S-1234567",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "s-1234567",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"user_id": {
"type": "string",
"description": "ID of the justification creator.",
"title": "user_id",
"x-displayname": "User ID",
"x-ves-example": "U-1234567",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "u-1234567",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for client_side_defenseUpdateScriptJustificationRequest",
"required_fields": [
"justification",
"script_id",
"user_id"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for client_side_defenseUpdateScriptJustificationRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  justification: value\n  script_id: value\n  user_id: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"justification\": \"value\",\n    \"script_id\": \"value\",\n    \"user_id\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"justification_id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"justification": "value",
"script_id": "value",
"user_id": "value"
}
},
"requiredFields": [
"justification",
"script_id",
"user_id"
],
"description": "Minimum configuration for client_side_defenseUpdateScriptJustificationRequest"
},
"fieldMetadata": {
"justification": {
"type": "string",
"description": "Script Justification.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"script_id": {
"type": "string",
"description": "ID of the script.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"user_id": {
"type": "string",
"description": "ID of the justification creator.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "justification_id",
"type": "string",
"description": "ID of the justification."
}
]
}
]
},
	"shape-csd-metadata-download": {
"name": "shape-csd-metadata-download",
"displayName": "Shape Csd Metadata Download",
"operations": [
{
"name": "list_shape_csd_metadata_download",
"description": "GET Report Download URL.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/reports/metadata/{job_id}/download",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "job_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"expires_in_seconds": {
"type": "string"
},
"presigned_url": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "expires_in_seconds",
"type": "string",
"description": "URL expiration in seconds."
},
{
"field": "presigned_url",
"type": "string",
"description": "Presigned URL for report download."
}
]
}
]
},
	"shape-csd-networkInteractions": {
"name": "shape-csd-networkInteractions",
"displayName": "Shape Csd Networkinteractions",
"operations": [
{
"name": "list_shape_csd_networkInteractions",
"description": "List Network Interactions By Script.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{id}/networkInteractions",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"network_interactions": {
"type": "array"
},
"total_size": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "network_interactions",
"type": "array",
"description": "List of network interactions depending upon time filter."
},
{
"field": "total_size",
"type": "integer",
"description": "Total size of scripts."
}
]
}
]
},
	"shape-csd-overview": {
"name": "shape-csd-overview",
"displayName": "Shape Csd Overview",
"operations": [
{
"name": "list_shape_csd_overview",
"description": "GET Scripts Overview.",
"method": "GET",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/overview",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"total_scripts": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "approval_status_counts",
"type": "object",
"description": ""
},
{
"field": "behavior_metrics",
"type": "object",
"description": ""
},
{
"field": "mitigation_status_counts",
"type": "object",
"description": ""
},
{
"field": "total_scripts",
"type": "integer",
"description": "Total number of scripts in the time range."
}
]
}
]
},
	"shape-csd-readStatus": {
"name": "shape-csd-readStatus",
"displayName": "Shape Csd Readstatus",
"operations": [
{
"name": "create_shape_csd_readStatu",
"description": "Update Script FormFields ReadStatus.",
"method": "POST",
"path": "/api/shape/csd/namespaces/{namespace}/scripts/{id}/readStatus",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to update.",
"title": "UpdateScriptReadStatusRequest",
"x-displayname": "Update Script FormFields ReadStatus request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptReadStatusRequest",
"properties": {
"id": {
"type": "string",
"description": "Script ID",
"title": "id",
"x-displayname": "Script ID",
"x-ves-example": "S-1234567",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-example": "s-1234567",
"x-validation-rules": {
"ves.io.schema.rules.string.not_empty": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/client_side_defenseACTION_TYPE"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for client_side_defenseUpdateScriptReadStatusRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for client_side_defenseUpdateScriptReadStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"script_name": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for client_side_defenseUpdateScriptReadStatusRequest"
},
"fieldMetadata": {
"id": {
"type": "string",
"description": "Script ID",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"type": {
"type": "string",
"description": "Type of Action\n\n- BLOCK: BLOCK\nBlock Form Field Read\n- ALLOW: ALLOW\nAllow Form Field Read.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "BLOCK"
}
},
"responseSummary": [
{
"field": "id",
"type": "string",
"description": "ID of the script."
},
{
"field": "script_name",
"type": "string",
"description": "Script detected in the webpage."
},
{
"field": "status",
"type": "string",
"description": "Values: not_modified , success\nStatus about script read status modification."
}
]
}
]
},
	"shape-csd-subscribe": {
"name": "shape-csd-subscribe",
"displayName": "Shape Csd Subscribe",
"operations": [
{
"name": "create_shape_csd_subscribe",
"description": "Subscribe to Client-Side Defense.",
"method": "POST",
"path": "/api/shape/csd/namespaces/system/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request of subscribe to Client-Side Defense.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.subscription.SubscribeRequest",
"x-f5xc-description-short": "Request of subscribe to Client-Side Defense.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionSubscribeRequest"
}
}
]
},
	"shape-csd-unsubscribe": {
"name": "shape-csd-unsubscribe",
"displayName": "Shape Csd Unsubscribe",
"operations": [
{
"name": "create_shape_csd_unsubscribe",
"description": "Unsubscribe to Client-Side Defense.",
"method": "POST",
"path": "/api/shape/csd/namespaces/system/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request of unsubscribe to Client-Side Defense.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.client_side_defense.subscription.UnsubscribeRequest",
"x-f5xc-description-short": "Request of unsubscribe to Client-Side Defense.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subscriptionUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subscriptionUnsubscribeRequest"
}
}
]
},
	"shape-dip-app-provision": {
"name": "shape-dip-app-provision",
"displayName": "Shape Dip App Provision",
"operations": [
{
"name": "create_shape_dip_app_provision",
"description": "Application Provision.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/app_provision",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Application Provision API.",
      "title": "ApplicationProvisionRequest",
"x-displayname": "Application Provision Request.",
"x-ves-proto-message": "ves.io.schema.shape.device_id.ApplicationProvisionRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml.",
      "title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-description-medium": "Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Application Provision API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idApplicationProvisionRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idApplicationProvisionRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idApplicationProvisionRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-dip-application": {
"name": "shape-dip-application",
"displayName": "Shape Dip Application",
"operations": [
{
"name": "delete_shape_dip_application",
"description": "DELETE Application.",
"method": "DELETE",
"path": "/api/shape/dip/namespaces/system/application",
      "dangerLevel": "high",
"parameters": [
{
"name": "app_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server. Body is JSON as described in openapi: https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml."
      }
]
},
{
"name": "create_shape_dip_application",
"description": "Update Application.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/application",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed to the Update Application API.",
      "title": "UpdateApplicationRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.UpdateApplicationRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml.",
      "title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-description-medium": "Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed to the Update Application API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idUpdateApplicationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idUpdateApplicationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idUpdateApplicationRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server. Body is JSON as described in openapi: https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml."
      }
]
}
]
},
	"shape-dip-applications": {
"name": "shape-dip-applications",
"displayName": "Shape Dip Applications",
"operations": [
{
"name": "list_shape_dip_applications",
"description": "GetApplications.",
"method": "GET",
"path": "/api/shape/dip/namespaces/system/applications",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server. Body is JSON as described in openapi: https://git.shpsec.com/shape-recognize/device-ID-management/blob/master/deployment/openapi/openapi-prod.yaml."
      }
]
}
]
},
	"shape-dip-bot-asn": {
"name": "shape-dip-bot-asn",
"displayName": "Shape Dip Bot Asn",
"operations": [
{
"name": "create_shape_dip_bot_asn",
"description": "GET Bot Assessment by Top ASN.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/bot/asn",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed to the Bot Top ASN API.",
      "title": "GetBotAssessmentTopAsnRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetBotAssessmentTopAsnRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed to the Bot Top ASN API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetBotAssessmentTopAsnRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetBotAssessmentTopAsnRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetBotAssessmentTopAsnRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-dip-bot-transactions": {
"name": "shape-dip-bot-transactions",
"displayName": "Shape Dip Bot Transactions",
"operations": [
{
"name": "create_shape_dip_bot_transaction",
"description": "GET Bot Assessment for Transactions.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/bot/transactions",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed to the Bot Transactions API.",
      "title": "GetBotAssessmentTransactionsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetBotAssessmentTransactionsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed to the Bot Transactions API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetBotAssessmentTransactionsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetBotAssessmentTransactionsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetBotAssessmentTransactionsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-dip-bot-urls": {
"name": "shape-dip-bot-urls",
"displayName": "Shape Dip Bot Urls",
"operations": [
{
"name": "create_shape_dip_bot_url",
"description": "GET Bot Assessment by Top URLs.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/bot/urls",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed to the Bot Top URLs API.",
      "title": "GetBotAssessmentTopUrlsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetBotAssessmentTopUrlsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed to the Bot Top URLs API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetBotAssessmentTopUrlsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetBotAssessmentTopUrlsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetBotAssessmentTopUrlsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-dip-dashboard-age": {
"name": "shape-dip-dashboard-age",
"displayName": "Shape Dip Dashboard Age",
"operations": [
{
"name": "create_shape_dip_dashboard_age",
"description": "GET Devices By Age.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/age",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard Age API.",
      "title": "GetDashboardByAgeRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardByAgeRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard Age API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardByAgeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardByAgeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardByAgeRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-dashboard-applications": {
"name": "shape-dip-dashboard-applications",
"displayName": "Shape Dip Dashboard Applications",
"operations": [
{
"name": "create_shape_dip_dashboard_application",
"description": "GET Information By Applications.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/applications",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard Application API.",
      "title": "GetDashboardByApplicationsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardByApplicationsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard Application API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardByApplicationsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardByApplicationsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardByApplicationsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-dashboard-asn": {
"name": "shape-dip-dashboard-asn",
"displayName": "Shape Dip Dashboard Asn",
"operations": [
{
"name": "create_shape_dip_dashboard_asn",
"description": "GET Devices By ASN.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/asn",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard ASN API.",
      "title": "GetDashboardByAsnRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardByAsnRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard ASN API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardByAsnRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardByAsnRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardByAsnRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-dashboard-country": {
"name": "shape-dip-dashboard-country",
"displayName": "Shape Dip Dashboard Country",
"operations": [
{
"name": "create_shape_dip_dashboard_country",
"description": "GET Devices By Country.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/country",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard Country API.",
      "title": "GetDashboardByCountryRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardByCountryRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard Country API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardByCountryRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardByCountryRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardByCountryRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-dashboard-session": {
"name": "shape-dip-dashboard-session",
"displayName": "Shape Dip Dashboard Session",
"operations": [
{
"name": "create_shape_dip_dashboard_session",
"description": "GET Devices By Session.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/session",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard Session API.",
      "title": "GetDashboardBySessionRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardBySessionRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard Session API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardBySessionRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardBySessionRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardBySessionRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-dashboard-ua": {
"name": "shape-dip-dashboard-ua",
"displayName": "Shape Dip Dashboard Ua",
"operations": [
{
"name": "create_shape_dip_dashboard_ua",
"description": "GET Devices By User-Agent.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/ua",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard UA API.",
      "title": "GetDashboardByUaRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardByUaRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard UA API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardByUaRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardByUaRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardByUaRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-dashboard-unique": {
"name": "shape-dip-dashboard-unique",
"displayName": "Shape Dip Dashboard Unique",
"operations": [
{
"name": "create_shape_dip_dashboard_unique",
"description": "GET Devices by Unique Access.",
      "method": "POST",
"path": "/api/shape/dip/namespaces/system/dashboard/unique",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Dashboard Unique API.",
      "title": "GetDashboardUniqueAccessRequest",
      "x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.device_id.GetDashboardUniqueAccessRequest",
      "properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Dashboard Unique API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idGetDashboardUniqueAccessRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idGetDashboardUniqueAccessRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idGetDashboardUniqueAccessRequest"
      },
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-enable": {
"name": "shape-dip-enable",
"displayName": "Shape Dip Enable",
"operations": [
{
"name": "create_shape_dip_enable",
"description": "Enable Application Traffic Insights.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/enable",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Provision API.",
      "title": "EnableRequest",
"x-displayname": "Enable Application Traffic Insights Request.",
"x-ves-proto-message": "ves.io.schema.shape.device_id.EnableRequest",
"properties": {
"region": {
"type": "string",
"description": "Target webpage to check src tag injection.",
"title": "Region",
"x-displayname": "Region",
"x-ves-example": "``https://www.example.com``",
"x-f5xc-example": "``https://www.example.com``",
"x-f5xc-description-short": "Target webpage to check src tag injection.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Any payload to be passed on the Provision API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idEnableRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idEnableRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idEnableRequest"
},
"fieldMetadata": {
"region": {
"type": "string",
"description": "Target webpage to check src tag injection.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-provision-regions": {
"name": "shape-dip-provision-regions",
"displayName": "Shape Dip Provision Regions",
"operations": [
{
"name": "list_shape_dip_provision_regions",
"description": "GET available Regions for Application Traffic Insights.",
"method": "GET",
"path": "/api/shape/dip/namespaces/system/provision/regions",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-status": {
"name": "shape-dip-status",
"displayName": "Shape Dip Status",
"operations": [
{
"name": "list_shape_dip_status",
"description": "GET Application Traffic Insights Status.",
"method": "GET",
"path": "/api/shape/dip/namespaces/system/status",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
},
{
"field": "status",
"type": "string",
"description": "HTTP status as reported by the backend."
}
]
}
]
},
	"shape-dip-validate-src-tag-injection": {
"name": "shape-dip-validate-src-tag-injection",
"displayName": "Shape Dip Validate Src Tag Injection",
"operations": [
{
"name": "create_shape_dip_validate_src_tag_injection",
"description": "Validate JS Injection.",
"method": "POST",
"path": "/api/shape/dip/namespaces/system/validate/src_tag_injection",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to verify shape Application Traffic Insights src tag injection.",
"title": "ValidateSrcTagInjectionRequest",
"x-displayname": "Validate SrcTagInjection Request.",
"x-ves-proto-message": "ves.io.schema.shape.device_id.ValidateSrcTagInjectionRequest",
"properties": {
"src": {
"type": "string",
"description": "Content to be present in customer webpage's source.",
"title": "Src",
"x-displayname": "Src",
"x-ves-example": "``https://dip.zeronaught.com/__imp_apg__/js/f5cs-a_aauvdjvrba-65bd8ebd.js``",
"x-f5xc-example": "``https://dip.zeronaught.com/__imp_apg__/js/f5cs-a_aauvdjvrba-65bd8ebd.js``",
"x-f5xc-description-short": "Content to be present in customer webpage's source.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"url": {
"type": "string",
"description": "Target webpage to check src tag injection.",
"title": "Url",
"x-displayname": "URL",
"x-ves-example": "``https://www.example.com``",
"x-f5xc-example": "``https://www.example.com``",
"x-f5xc-description-short": "Target webpage to check src tag injection.",
"format": "uri",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to verify shape Application Traffic Insights src tag injection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for device_idValidateSrcTagInjectionRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for device_idValidateSrcTagInjectionRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "data_and_privacy_security"
},
"responseSchema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for device_idValidateSrcTagInjectionRequest"
},
"fieldMetadata": {
"src": {
"type": "string",
"description": "Content to be present in customer webpage's source.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"url": {
"type": "string",
"description": "Target webpage to check src tag injection.",
"constraints": {
"constraintType": "string",
"category": "network",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "inferred",
"confidence": 0.9,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "message",
"type": "string",
"description": "Status about src script tag injected in customer's webpage."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-channel": {
"name": "shape-recognize-recognize-addon-dashboard-channel",
"displayName": "Shape Recognize Recognize Addon Dashboard Channel",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_channel",
"description": "Channel Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/channel",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Channel Request.",
"title": "Channel Request",
"x-displayname": "Channel Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.ChannelRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the channel data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the channel data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The time since we want the channel data.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Since and to times to generate the Channel Request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeChannelRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeChannelRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeChannelRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the channel data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the channel data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Lift Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-conversion": {
"name": "shape-recognize-recognize-addon-dashboard-conversion",
"displayName": "Shape Recognize Recognize Addon Dashboard Conversion",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_conversion",
"description": "Conversion Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/conversion",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Conversion request.",
"title": "ConversionRequest",
"x-displayname": "Conversion Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.ConversionRequest",
"properties": {
"agent": {
"type": "string",
"description": "Agent data.",
"title": "agent",
"x-displayname": "Agent",
"x-ves-example": "F5cs",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "f5cs",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"endTime": {
"type": "string",
"description": "The time to we want the conversion data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The time to we want the conversion data.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the conversion data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The time since we want the conversion data.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tenant": {
"type": "string",
"description": "Tenant data.",
"title": "tenant",
"x-displayname": "Tenant",
"x-ves-example": "Miguel",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "miguel",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only",
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Since and to times to generate the Conversion request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeConversionRequest",
"required_fields": [
"agent",
"endTime",
"startTime",
"tenant"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeConversionRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  agent: value\n  endTime: value\n  startTime: value\n  tenant: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"agent\": \"value\",\n    \"endTime\": \"value\",\n    \"startTime\": \"value\",\n    \"tenant\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"agent": "value",
"endTime": "value",
"startTime": "value",
"tenant": "value"
}
},
"requiredFields": [
"agent",
"endTime",
"startTime",
"tenant"
],
"description": "Minimum configuration for recognizeConversionRequest"
},
"fieldMetadata": {
"agent": {
"type": "string",
"description": "Agent data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"endTime": {
"type": "string",
"description": "The time to we want the conversion data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the conversion data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"tenant": {
"type": "string",
"description": "Tenant data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Conversion Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-enjoy": {
"name": "shape-recognize-recognize-addon-dashboard-enjoy",
"displayName": "Shape Recognize Recognize Addon Dashboard Enjoy",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_enjoy",
"description": "Enjoy Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/enjoy",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Enjoy Request.",
"title": "Enjoy Request",
"x-displayname": "Enjoy Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.EnjoyRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the enjoy data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the enjoy data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Since and to times to generate the Enjoy Request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeEnjoyRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeEnjoyRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeEnjoyRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the enjoy data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the enjoy data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Lift Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-friction-aggregation": {
"name": "shape-recognize-recognize-addon-dashboard-friction-aggregation",
"displayName": "Shape Recognize Recognize Addon Dashboard Friction Aggregation",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_friction_aggregation",
"description": "Friction Aggregation Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_aggregation",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Friction Aggregation Request.",
"title": "Friction Aggregation Request",
"x-displayname": "Friction Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionAggregationRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the channel data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the channel data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The time since we want the channel data.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Since and to times to generate the Friction Aggregation Request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeFrictionAggregationRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeFrictionAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeFrictionAggregationRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the channel data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the channel data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Lift Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-friction-histogram": {
"name": "shape-recognize-recognize-addon-dashboard-friction-histogram",
"displayName": "Shape Recognize Recognize Addon Dashboard Friction Histogram",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_friction_histogram",
"description": "Friction Histogram Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_histogram",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Friction Histogram Request.",
"title": "Friction Histogram Request",
"x-displayname": "Friction Histogram Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionHistogramRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the channel data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000001.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000001",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the channel data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400001.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400001",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "The time since we want the channel data.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Since and to times to generate the Friction Histogram Request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeFrictionHistogramRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeFrictionHistogramRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeFrictionHistogramRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the channel data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the channel data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Lift Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-health": {
"name": "shape-recognize-recognize-addon-dashboard-health",
"displayName": "Shape Recognize Recognize Addon Dashboard Health",
"operations": [
{
"name": "list_shape_recognize_recognize_addon_dashboard_health",
"description": "Health Check.",
"method": "GET",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/health",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "message",
"type": "string",
"description": "Message"
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-lift": {
"name": "shape-recognize-recognize-addon-dashboard-lift",
"displayName": "Shape Recognize Recognize Addon Dashboard Lift",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_lift",
"description": "Lift Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/lift",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Lift Request.",
"title": "Lift Request",
"x-displayname": "Lift Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.LiftRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the lift data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the lift data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Since and to times to generate the Lift Request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeLiftRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeLiftRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeLiftRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the lift data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the lift data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Lift Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-rescue": {
"name": "shape-recognize-recognize-addon-dashboard-rescue",
"displayName": "Shape Recognize Recognize Addon Dashboard Rescue",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_rescue",
"description": "Rescue Dashboard.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/rescue",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Since and to times to generate the Rescue Request.",
"title": "Rescue Request",
"x-displayname": "Rescue Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.RescueRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the rescue data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"title": "itemUnit",
"x-displayname": "ItemUnit",
"x-ves-example": "D",
"x-f5xc-example": "d",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the rescue data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Since and to times to generate the Rescue Request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeRescueRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeRescueRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeRescueRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the rescue data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"itemUnit": {
"type": "string",
"description": "The unit where the data is represented.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the rescue data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Rescue Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-dashboard-top-reason-code": {
"name": "shape-recognize-recognize-addon-dashboard-top-reason-code",
"displayName": "Shape Recognize Recognize Addon Dashboard Top Reason Code",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_dashboard_top_reason_code",
"description": "Top Reason Codes.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/top_reason_code",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Top Reason Codes Request.",
"title": "TopReasonCodesRequest",
"x-displayname": "TopReasonCodesRequest.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.TopReasonCodesRequest",
"properties": {
"endTime": {
"type": "string",
"description": "The time to we want the rescue data.",
"title": "endTime",
"format": "int64",
"x-displayname": "EndTime",
"x-ves-example": "1639008000000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1639008000000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the rescue data.",
"title": "startTime",
"format": "int64",
"x-displayname": "StartTime",
"x-ves-example": "1607558400000.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "1607558400000",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeTopReasonCodesRequest",
"required_fields": [
"endTime",
"startTime"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeTopReasonCodesRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  endTime: value\n  startTime: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"endTime\": \"value\",\n    \"startTime\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"endTime": "value",
"startTime": "value"
}
},
"requiredFields": [
"endTime",
"startTime"
],
"description": "Minimum configuration for recognizeTopReasonCodesRequest"
},
"fieldMetadata": {
"endTime": {
"type": "string",
"description": "The time to we want the rescue data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"startTime": {
"type": "string",
"description": "The time since we want the rescue data.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "int64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the Rescue Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-provision": {
"name": "shape-recognize-recognize-addon-provision",
"displayName": "Shape Recognize Recognize Addon Provision",
"operations": [
{
"name": "list_shape_recognize_recognize_addon_provision",
"description": "GET Recognize Provision Status Addon.",
"method": "GET",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/provision",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"bid": {
"type": "string"
},
"id": {
"type": "string"
},
"src": {
"type": "string"
},
"tag": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "Provision API Version."
      },
{
"field": "bid",
"type": "string",
"description": "Backend identifier."
},
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "ID response."
},
{
"field": "src",
"type": "string",
"description": "Javascript tag src attribute."
},
{
"field": "tag",
"type": "string",
"description": "Javascript tag injected to URL paths that user configures."
}
]
}
]
},
	"shape-recognize-recognize-addon-state": {
"name": "shape-recognize-recognize-addon-state",
"displayName": "Shape Recognize Recognize Addon State",
"operations": [
{
"name": "list_shape_recognize_recognize_addon_state",
"description": "State",
"method": "GET",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/state",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"apiVersion": {
      "type": "string"
},
"id": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "apiVersion",
      "type": "string",
"description": "The actual version of the shape recognize API."
      },
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "id",
"type": "string",
"description": "The ID from the State Response."
}
]
}
]
},
	"shape-recognize-recognize-addon-subscribe": {
"name": "shape-recognize-recognize-addon-subscribe",
"displayName": "Shape Recognize Recognize Addon Subscribe",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_subscribe",
"description": "Subscribe to Shape Recognize.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Subscribe API.",
      "title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.SubscribeRequest",
"x-f5xc-description-short": "Any payload to be passed on the Subscribe API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for recognizeSubscribeRequest"
}
}
]
},
	"shape-recognize-recognize-addon-unsubscribe": {
"name": "shape-recognize-recognize-addon-unsubscribe",
"displayName": "Shape Recognize Recognize Addon Unsubscribe",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_unsubscribe",
"description": "Unsubscribe to Shape Recognize.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Unsubscribe API.",
      "title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.UnsubscribeRequest",
"x-f5xc-description-short": "Any payload to be passed on the Unsubscribe API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for recognizeUnsubscribeRequest"
}
}
]
},
	"shape-recognize-recognize-addon-validate-src-tag-injection": {
"name": "shape-recognize-recognize-addon-validate-src-tag-injection",
"displayName": "Shape Recognize Recognize Addon Validate Src Tag Injection",
"operations": [
{
"name": "create_shape_recognize_recognize_addon_validate_src_tag_injection",
"description": "ValidateSrcTagInjection Addon.",
"method": "POST",
"path": "/api/shape/recognize/namespaces/system/recognize/addon/validate/src_tag_injection",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to verify shape recognize src tag injection.",
"title": "ValidateSrcTagInjectionRequest",
"x-displayname": "Validate SrcTagInjection Request.",
"x-ves-proto-message": "ves.io.schema.shape.recognize.ValidateSrcTagInjectionRequest",
"properties": {
"src": {
"type": "string",
"description": "Content to be present in customer webpage's source.",
"title": "Src",
"x-displayname": "Src",
"x-ves-example": "``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js``",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.uri_ref": "true"
},
"x-f5xc-example": "``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js``",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.uri_ref": "true"
},
"x-f5xc-description-short": "Content to be present in customer webpage's source.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"url": {
"type": "string",
"description": "Target webpage to check src tag injection.",
"title": "Url",
"x-displayname": "URL",
"x-ves-example": "``https://www.example.com``",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.uri": "true"
},
"x-f5xc-example": "``https://www.example.com``",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.uri": "true"
},
"x-f5xc-description-short": "Target webpage to check src tag injection.",
"format": "uri",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to verify shape recognize src tag injection.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for recognizeValidateSrcTagInjectionRequest",
"required_fields": [
"src",
"url"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for recognizeValidateSrcTagInjectionRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  src: value\n  url: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"src\": \"value\",\n    \"url\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"isInjected": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"src": "value",
"url": "value"
}
},
"requiredFields": [
"src",
"url"
],
"description": "Minimum configuration for recognizeValidateSrcTagInjectionRequest"
},
"fieldMetadata": {
"src": {
"type": "string",
"description": "Content to be present in customer webpage's source.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"url": {
"type": "string",
"description": "Target webpage to check src tag injection.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "uri",
"minLength": 1,
"pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$",
"formatDescription": "RFC 3986 URI with scheme (http, https, ftp)",
"validation": {
"rfc": "RFC 3986"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "isInjected",
"type": "boolean",
"description": "Status about src script tag injected in customer's webpage."
},
{
"field": "message",
"type": "string",
"description": "The error string if not injected."
}
]
}
]
},
	"shape-safe-sas-block-audit": {
"name": "shape-safe-sas-block-audit",
"displayName": "Shape Safe Sas Block Audit",
"operations": [
{
"name": "list_shape_safe_sas_block_audit",
"description": "GET SAFE Block table list.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/audit",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dimt",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "dimv",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-block-csv-audit": {
"name": "shape-safe-sas-block-csv-audit",
"displayName": "Shape Safe Sas Block Csv Audit",
"operations": [
{
"name": "list_shape_safe_sas_block_csv_audit",
"description": "GET SAFE Analyst Block Audit as a CSV file.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/csv/audit",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "dimt",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "dimv",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-block-csv-table": {
"name": "shape-safe-sas-block-csv-table",
"displayName": "Shape Safe Sas Block Csv Table",
"operations": [
{
"name": "list_shape_safe_sas_block_csv_table",
"description": "GET SAFE Analyst Block Table as a CSV file.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/csv/table",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "from",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "action",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-block-details": {
"name": "shape-safe-sas-block-details",
"displayName": "Shape Safe Sas Block Details",
"operations": [
{
"name": "list_shape_safe_sas_block_details",
"description": "GET SAFE Block Details.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/details",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "account_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "device_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-block-feedback": {
"name": "shape-safe-sas-block-feedback",
"displayName": "Shape Safe Sas Block Feedback",
"operations": [
{
"name": "create_shape_safe_sas_block_feedback",
"description": "PostSafeBlockFeedback.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/feedback",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Block Feedback POST API.",
      "title": "PostSafeBlockFeedbackRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeBlockFeedbackRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Block Feedback POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeBlockFeedbackRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeBlockFeedbackRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeBlockFeedbackRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-block-rule": {
"name": "shape-safe-sas-block-rule",
"displayName": "Shape Safe Sas Block Rule",
"operations": [
{
"name": "create_shape_safe_sas_block_rule",
"description": "PostSafeBlockRule.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/rule",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Block Rule POST API.",
      "title": "PostSafeBlockRuleRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeBlockRuleRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Block Rule POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeBlockRuleRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeBlockRuleRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeBlockRuleRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-block-table": {
"name": "shape-safe-sas-block-table",
"displayName": "Shape Safe Sas Block Table",
"operations": [
{
"name": "list_shape_safe_sas_block_table",
"description": "GET SAFE Block table list.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/block/table",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "from",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "action",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-ep": {
"name": "shape-safe-sas-ep",
"displayName": "Shape Safe Sas Ep",
"operations": [
{
"name": "create_shape_safe_sas_ep",
"description": "PostSafeEp.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/ep",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Ep POST API.",
      "title": "PostSafeEpRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeEpRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The ep name.",
"title": "Name",
"maxLength": 256,
"x-displayname": "Requested Ep name.",
"x-ves-example": "Transactions.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "transactions",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Ep POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeEpRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeEpRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeEpRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The ep name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-feedback": {
"name": "shape-safe-sas-feedback",
"displayName": "Shape Safe Sas Feedback",
"operations": [
{
"name": "create_shape_safe_sas_feedback",
"description": "Update Fraud Feedback.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/feedback",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"title": "PostFeedbackRequest",
"x-displayname": "Safe SAS feedback request.",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostFeedbackRequest",
"properties": {
"comment": {
"type": "string",
"description": "Transaction Comment.",
"title": "Transaction Comment",
"maxLength": 2048,
"x-displayname": "Transaction Comment.",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "2048"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "2048"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"feedback": {
"type": "string",
"description": "Transaction Feedback.",
"title": "Transaction Feedback",
"maxLength": 64,
"x-displayname": "Transaction Feedback.",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "64"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "64"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"transaction_id": {
"type": "string",
"description": "Transaction identifier.",
"title": "Transaction Id",
"maxLength": 256,
"x-displayname": "Transaction ID.",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostFeedbackRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostFeedbackRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostFeedbackRequest"
},
"fieldMetadata": {
"comment": {
"type": "string",
"description": "Transaction Comment.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 2048,
"minLength": 0,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"feedback": {
"type": "string",
"description": "Transaction Feedback.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"transaction_id": {
"type": "string",
"description": "Transaction identifier.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-general-feedback": {
"name": "shape-safe-sas-general-feedback",
"displayName": "Shape Safe Sas General Feedback",
"operations": [
{
"name": "create_shape_safe_sas_general_feedback",
"description": "Update Fraud Feedback.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/general_feedback",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe SAS Transactions CSV API.",
      "title": "PostGeneralFeedbackRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostGeneralFeedbackRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"maximum": 512,
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "512"
},
"x-f5xc-example": "cGF5bG9hZAo=",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "512"
},
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"format": "byte",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe SAS Transactions CSV API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostGeneralFeedbackRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostGeneralFeedbackRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostGeneralFeedbackRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"format": "byte",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-health": {
"name": "shape-safe-sas-health",
"displayName": "Shape Safe Sas Health",
"operations": [
{
"name": "list_shape_safe_sas_health",
"description": "GetHealthRequest.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/health",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object"
}
}
]
},
	"shape-safe-sas-provision": {
"name": "shape-safe-sas-provision",
"displayName": "Shape Safe Sas Provision",
"operations": [
{
"name": "create_shape_safe_sas_provision",
"description": "PostSafeProvision.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/provision",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Provision POST API.",
      "title": "PostSafeProvisionRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeProvisionRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Provision POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeProvisionRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeProvisionRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeProvisionRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-stats-overview": {
"name": "shape-safe-sas-stats-overview",
"displayName": "Shape Safe Sas Stats Overview",
"operations": [
{
"name": "list_shape_safe_sas_stats_overview",
"description": "GET SAFE Overview.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/overview",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "from",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
},
{
"name": "create_shape_safe_sas_stats_overview",
"description": "PostSafeOverview.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/overview",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.",
      "title": "PostSafeOverviewRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeOverviewRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeOverviewRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeOverviewRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeOverviewRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-stats-top-locations": {
"name": "shape-safe-sas-stats-top-locations",
"displayName": "Shape Safe Sas Stats Top Locations",
"operations": [
{
"name": "list_shape_safe_sas_stats_top_locations",
"description": "GET SAFE Top Locations.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/top_locations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "from",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
},
{
"name": "create_shape_safe_sas_stats_top_location",
"description": "POST SAFE Top Locations.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/top_locations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.",
      "title": "PostSafeStatsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeStatsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeStatsRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeStatsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeStatsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-stats-top-sources": {
"name": "shape-safe-sas-stats-top-sources",
"displayName": "Shape Safe Sas Stats Top Sources",
"operations": [
{
"name": "list_shape_safe_sas_stats_top_sources",
"description": "GET SAFE Top Sources.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/top_sources",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "from",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
},
{
"name": "create_shape_safe_sas_stats_top_source",
"description": "POST SAFE Top Sources.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/top_sources",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.",
      "title": "PostSafeStatsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeStatsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeStatsRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeStatsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeStatsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-stats-transactions-over-time": {
"name": "shape-safe-sas-stats-transactions-over-time",
"displayName": "Shape Safe Sas Stats Transactions Over Time",
"operations": [
{
"name": "create_shape_safe_sas_stats_transactions_over_time",
"description": "PostSafeTransactionsOverTime.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/transactions_over_time",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Dashboard Transaction Over Time POST API.",
      "title": "PostSafeTransactionsOverTimeRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsOverTimeRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Over Time POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionsOverTimeRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionsOverTimeRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionsOverTimeRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-summary": {
"name": "shape-safe-sas-summary",
"displayName": "Shape Safe Sas Summary",
"operations": [
{
"name": "list_shape_safe_sas_summary",
"description": "GET SAFE Analyst Summary.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/summary",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "from",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transaction-details": {
"name": "shape-safe-sas-transaction-details",
"displayName": "Shape Safe Sas Transaction Details",
"operations": [
{
"name": "list_shape_safe_sas_transaction_details",
"description": "GET SAFE Anayst Transaction Details.",
"method": "GET",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_details",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "transaction_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
},
{
"name": "create_shape_safe_sas_transaction_detail",
"description": "PostSafeTransactionDetails.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_details",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Transactions Details POST API.",
      "title": "PostSafeTransactionDetailsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionDetailsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Details POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionDetailsRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionDetailsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionDetailsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transaction-device-history": {
"name": "shape-safe-sas-transaction-device-history",
"displayName": "Shape Safe Sas Transaction Device History",
"operations": [
{
"name": "create_shape_safe_sas_transaction_device_history",
"description": "PostSafeTransactionDeviceHistory.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_device_history",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Transactions Device Hisotry POST API.",
      "title": "PostSafeTransactionDeviceHistoryRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionDeviceHistoryRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Device Hisotry POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionDeviceHistoryRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionDeviceHistoryRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionDeviceHistoryRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transaction-locations": {
"name": "shape-safe-sas-transaction-locations",
"displayName": "Shape Safe Sas Transaction Locations",
"operations": [
{
"name": "create_shape_safe_sas_transaction_location",
"description": "PostSafeTransactionLocations.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_locations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Transactions Location POST API.",
      "title": "PostSafeTransactionLocationsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionLocationsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Location POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionLocationsRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionLocationsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionLocationsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transaction-related-sessions": {
"name": "shape-safe-sas-transaction-related-sessions",
"displayName": "Shape Safe Sas Transaction Related Sessions",
"operations": [
{
"name": "create_shape_safe_sas_transaction_related_session",
"description": "PostSafeTransactionRelatedSessions.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_related_sessions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Transactions Related Sessions POST API.",
      "title": "PostSafeTransactionRelatedSessionsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionRelatedSessionsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Related Sessions POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionRelatedSessionsRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionRelatedSessionsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionRelatedSessionsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transaction-timeline": {
"name": "shape-safe-sas-transaction-timeline",
"displayName": "Shape Safe Sas Transaction Timeline",
"operations": [
{
"name": "create_shape_safe_sas_transaction_timeline",
"description": "PostSafeTransactionTimeline.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_timeline",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe Transactions Timeline POST API.",
      "title": "PostSafeTransactionTimelineRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionTimelineRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Timeline POST API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionTimelineRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionTimelineRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionTimelineRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transactions": {
"name": "shape-safe-sas-transactions",
"displayName": "Shape Safe Sas Transactions",
"operations": [
{
"name": "create_shape_safe_sas_transaction",
"description": "List SAFE Analyst Transactions.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transactions",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe SAS Transactions API.",
      "title": "PostSafeTransactionsRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe SAS Transactions API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionsRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionsRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"shape-safe-sas-transactions-csv": {
"name": "shape-safe-sas-transactions-csv",
"displayName": "Shape Safe Sas Transactions Csv",
"operations": [
{
"name": "create_shape_safe_sas_transactions_csv",
"description": "GET SAFE Analyst Transactions as a CSV file.",
"method": "POST",
"path": "/api/shape/safe/namespaces/{namespace}/safe/sas/transactions_csv",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Any payload to be passed on the Safe SAS Transactions CSV API.",
      "title": "PostSafeTransactionsCsvRequest",
"x-displayname": "Input",
"x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsCsvRequest",
"properties": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"title": "Body",
"format": "byte",
"x-displayname": "Body",
"x-ves-example": "CGF5bG9hZAo=.",
"x-f5xc-example": "cGF5bG9hZAo=",
"x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Payment-app-namespace-1.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "payment-app-namespace-1",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "The API version to use.",
      "title": "Version",
"maxLength": 16,
"x-displayname": "Requested API version.",
      "x-ves-example": "V2",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-example": "v2",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "16"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Any payload to be passed on the Safe SAS Transactions CSV API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for safePostSafeTransactionsCsvRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for safePostSafeTransactionsCsvRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for safePostSafeTransactionsCsvRequest"
},
"fieldMetadata": {
"body": {
"type": "string",
"description": "Data to be send as the body of request. Note that multipart/formdata is not supported.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the query.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "The API version to use.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "body",
"type": "string",
"description": "Data received from the downstream server."
}
]
}
]
},
	"sid-counters": {
"name": "sid-counters",
"displayName": "Sid Counters",
"operations": [
{
"name": "create_sid_counter",
"description": "SID Counters.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/virtual_network/sid_counters",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the SID Counters.",
"title": "SID Counter Request",
"x-displayname": "SID Counter Request.",
"x-ves-proto-message": "ves.io.schema.virtual_network.SIDCounterRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {SID_COUNTER_IN_BYTES, SID_COUNTER_IN_PACKETS, SID_COUNTER_OUT_BYTES, SID_COUNTER_OUT_PACKETS} can be specified.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/virtual_networkSIDCounterType"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {SID_COUNTER_IN_BYTES, SID_COUNTER_IN_PACKETS, SID_COUNTER_OUT_BYTES, SID_COUNTER_OUT_PACKETS} can be specified.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in SIDCounterLabel {SITE, VIRTUAL_NETWORK, SID_PREFIX} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{SITE=\\\"site-1\\\"}",
"x-f5xc-example": "\"{SITE=\\\"site-1\\\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in SIDCounterLabel {SITE, VIRTUAL_NETWORK, SID_PREFIX} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"]...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {SITE, VIRTUAL_NETWORK, SID_PREFIX}",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/virtual_networkSIDCounterLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by zero or more labels {SITE, VIRTUAL_NETWORK, SID_PREFIX}.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Only `system` namespace is supported.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_networkSIDCounterRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_networkSIDCounterRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for virtual_networkSIDCounterRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {SID_COUNTER_IN_BYTES, SID_COUNTER_IN_PACKETS, SID_COUNTER_OUT_BYTES, SID_COUNTER_OUT_PACKETS} can be specified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in SIDCounterLabel {SITE, VIRTUAL_NETWORK, SID_PREFIX} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {SITE, VIRTUAL_NETWORK, SID_PREFIX}",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Only `system` namespace is supported.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series data for SID counters."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"site": {
"name": "site",
"displayName": "Site",
"operations": [
{
"name": "create_site",
"description": "Site Graph Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/site",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Graph/site API is used to GET intra-site and inter-site graph for application traffic.",
      "title": "Site Graph Request",
"x-displayname": "Site Graph Request.",
"x-ves-proto-message": "ves.io.schema.graph.site.Request",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/siteFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by site.\nOptional: If not specified, then the data is aggregated/grouped by site.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/siteIdField"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, application traffic for all sites will be returned in the response.",
      "title": "Label Filter",
"items": {
"$ref": "#/components/schemas/siteLabelFilter"
},
"x-displayname": "Label Filter.",
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, application traffic for all sites will be returned in the response.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
"x-f5xc-description-medium": "Namespace is used to scope the application traffic to a given namespace. For system namespace, application traffic across all namespaces for the tenant will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Graph/site API is used to GET intra-site and inter-site graph for application traffic.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for siteRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "FieldSelector is used to specify the list of fields to be returned in the response for site graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.edge.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.node.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by site.\nOptional: If not specified, then the data is aggregated/grouped by site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, application traffic for all sites will be returned in the response.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"site-apis-apps-v1": {
"name": "site-apis-apps-v1",
      "displayName": "Site Apis Apps V1",
      "operations": [
{
"name": "list_site_apis_apps_v1",
      "description": "DaemonSet List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/daemonsets",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "A list of daemon sets."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-apps-v1-daemonsets": {
"name": "site-apis-apps-v1-daemonsets",
      "displayName": "Site Apis Apps V1 Daemonsets",
      "operations": [
{
"name": "list_site_apis_apps_v1_daemonsets",
      "description": "DaemonSet List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/apps/v1/daemonsets",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "A list of daemon sets."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-apps-v1-deployments": {
"name": "site-apis-apps-v1-deployments",
      "displayName": "Site Apis Apps V1 Deployments",
      "operations": [
{
"name": "list_site_apis_apps_v1_deployments",
      "description": "Deployment List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/apps/v1/deployments",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items is the list of Deployments."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-apps-v1-replicasets": {
"name": "site-apis-apps-v1-replicasets",
      "displayName": "Site Apis Apps V1 Replicasets",
      "operations": [
{
"name": "list_site_apis_apps_v1_replicasets",
      "description": "ReplicaSet List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/apps/v1/replicasets",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-apps-v1-statefulsets": {
"name": "site-apis-apps-v1-statefulsets",
      "displayName": "Site Apis Apps V1 Statefulsets",
      "operations": [
{
"name": "list_site_apis_apps_v1_statefulsets",
      "description": "StatefulSet List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/apps/v1/statefulsets",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-batch-v1": {
"name": "site-apis-batch-v1",
      "displayName": "Site Apis Batch V1",
      "operations": [
{
"name": "list_site_apis_batch_v1",
      "description": "Job List",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/batch/v1/namespaces/{namespace}/jobs",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items is the list of Jobs."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-batch-v1-jobs": {
"name": "site-apis-batch-v1-jobs",
      "displayName": "Site Apis Batch V1 Jobs",
      "operations": [
{
"name": "list_site_apis_batch_v1_jobs",
      "description": "Job List",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/batch/v1/jobs",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items is the list of Jobs."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-batch-v1beta1": {
"name": "site-apis-batch-v1beta1",
      "displayName": "Site Apis Batch V1Beta1",
      "operations": [
{
"name": "list_site_apis_batch_v1beta1",
      "description": "CronJob List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/batch/v1beta1/namespaces/{namespace}/cronjobs",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items is the list of CronJobs."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-apis-batch-v1beta1-cronjobs": {
"name": "site-apis-batch-v1beta1-cronjobs",
      "displayName": "Site Apis Batch V1Beta1 Cronjobs",
      "operations": [
{
"name": "list_site_apis_batch_v1beta1_cronjobs",
      "description": "CronJob List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/apis/batch/v1beta1/cronjobs",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items is the list of CronJobs."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-edge": {
"name": "site-edge",
"displayName": "Site Edge",
"operations": [
{
"name": "create_site_edge",
"description": "Site Edge Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/site/edge",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the time-series data for an edge in the site graph.\nWhile graph/site API is used to GET application traffic for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/site/edge API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.",
      "title": "Site Edge Request",
"x-displayname": "Site Edge Request.",
"x-ves-proto-message": "ves.io.schema.graph.site.EdgeRequest",
"properties": {
"dst_id": {
"allOf": [
{
"$ref": "#/components/schemas/siteId"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/siteEdgeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
"x-f5xc-description-medium": "Namespace is used to scope the application traffic to a given namespace. For system namespace, application traffic across all namespaces for the tenant will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id": {
"allOf": [
{
"$ref": "#/components/schemas/siteId"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the time-series data for an edge in the site graph.",
"x-f5xc-description-medium": "Request to GET the time-series data for an edge in the site graph. While graph/site API is used to GET application traffic for all sites, where each node and edge contains the aggregated value for each field; graph/site/edge API is used to GET the time-series data (drill-down of aggregated data)...",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteEdgeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteEdgeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for siteEdgeRequest"
},
"fieldMetadata": {
"dst_id": {
"type": "object",
"description": "ID uniquely identifies a node or an edge in the site graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"dst_id.site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.types": {
"type": "array",
"description": "Specify list of metrics that should be returned for each edge in the connectivity graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id": {
"type": "object",
"description": "ID uniquely identifies a node or an edge in the site graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"src_id.site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"site-mesh-groups": {
"name": "site-mesh-groups",
"displayName": "Site Mesh Groups",
"operations": [
{
"name": "create_site_mesh_group",
"description": "Create Site Mesh Group.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/site_mesh_groups",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of site_mesh_group",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.site_mesh_group.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/schemasite_mesh_groupCreateSpecType"
}
],
"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 site_mesh_groupCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for site_mesh_groupCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for site_mesh_groupCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a Site Mesh Group in system namespace of user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bfd_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bfd_enabled": {
"type": "object",
"description": "BFD parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bfd_enabled.multiplier": {
"type": "integer",
"description": "Specify Number of missed packets to bring session down\"",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2,
"maximum": 255,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.bfd_enabled.receive_interval_milliseconds": {
"type": "integer",
"description": "BFD receive interval timer, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 300,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.bfd_enabled.transmit_interval_milliseconds": {
"type": "integer",
"description": "BFD transmit interval timer, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 300,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_re_fallback": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_re_fallback": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.full_mesh": {
"type": "object",
"description": "Details of Full Mesh Group Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.full_mesh.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.full_mesh.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hub_mesh": {
"type": "object",
"description": "Details of Hub Full Mesh Group Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hub_mesh.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hub_mesh.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh": {
"type": "object",
"description": "Details of Spoke Mesh Group Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh.hub_mesh_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_site": {
"type": "array",
"description": "Set of sites for which this mesh group config is valid.\nIf 'Type' is Spoke, then it gives set of spoke sites.\nIf 'Type' is Hub, then it gives set of hub sites.\nIf 'Type' is Full Mesh, then it gives set of sites that are connected in full mesh.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.bfd_choice": [
"bfd_disabled",
"bfd_enabled"
],
"spec.mesh_choice": [
"full_mesh",
"hub_mesh",
"spoke_mesh"
],
"spec.re_fallback": [
"disable_re_fallback",
"enable_re_fallback"
],
"spec.full_mesh.full_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
],
"spec.hub_mesh.hub_full_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
],
"spec.spoke_mesh.spoke_hub_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_site_mesh_group",
"description": "Replace Site Mesh Group.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/site_mesh_groups/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a site_mesh_group",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.site_mesh_group.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/schemasite_mesh_groupReplaceSpecType"
}
],
"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 site_mesh_groupReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for site_mesh_groupReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for site_mesh_groupReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace contents of a Site Mesh Group object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bfd_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bfd_enabled": {
"type": "object",
"description": "BFD parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bfd_enabled.multiplier": {
"type": "integer",
"description": "Specify Number of missed packets to bring session down\"",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2,
"maximum": 255,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.bfd_enabled.receive_interval_milliseconds": {
"type": "integer",
"description": "BFD receive interval timer, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 300,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.bfd_enabled.transmit_interval_milliseconds": {
"type": "integer",
"description": "BFD transmit interval timer, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 300,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.disable_re_fallback": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_re_fallback": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.full_mesh": {
"type": "object",
"description": "Details of Full Mesh Group Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.full_mesh.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.full_mesh.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hub_mesh": {
"type": "object",
"description": "Details of Hub Full Mesh Group Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hub_mesh.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hub_mesh.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh": {
"type": "object",
"description": "Details of Spoke Mesh Group Type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh.control_and_data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh.data_plane_mesh": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.spoke_mesh.hub_mesh_group": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.virtual_site": {
"type": "array",
"description": "Set of sites for which this mesh group config is valid.\nIf 'Type' is Spoke, then it gives set of spoke sites.\nIf 'Type' is Hub, then it gives set of hub sites.\nIf 'Type' is Full Mesh, then it gives set of sites that are connected in full mesh.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.bfd_choice": [
"bfd_disabled",
"bfd_enabled"
],
"spec.mesh_choice": [
"full_mesh",
"hub_mesh",
"spoke_mesh"
],
"spec.re_fallback": [
"disable_re_fallback",
"enable_re_fallback"
],
"spec.full_mesh.full_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
],
"spec.hub_mesh.hub_full_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
],
"spec.spoke_mesh.spoke_hub_mesh_choice": [
"control_and_data_plane_mesh",
"data_plane_mesh"
]
}
},
{
"name": "list_site_mesh_groups",
"description": "List Site Mesh Group.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/site_mesh_groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_site_mesh_group",
"description": "DELETE Site Mesh Group.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/site_mesh_groups/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a site_mesh_group",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.site_mesh_group.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for site_mesh_groupDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for site_mesh_groupDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "service_mesh"
}
},
{
"name": "get_site_mesh_group",
"description": "GET Site Mesh Group.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/site_mesh_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"site-metrics": {
"name": "site-metrics",
"displayName": "Site Metrics",
"operations": [
{
"name": "create_site_metric",
"description": "Pods Metrics.",
"method": "POST",
"path": "/api/data/namespaces/system/site/{site}/namespaces/{namespace}/pods/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET Pods Metrics.",
"title": "PodsMetricsRequest",
"x-displayname": "Pods Metrics Request.",
"x-ves-proto-message": "ves.io.schema.site.PodsMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-medium": "End time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "string",
"description": "Filter to filter the metrics by the given label.",
"title": "Filter",
"x-displayname": "Filter",
"x-ves-example": "Namespace=example-namespace.",
"x-f5xc-example": "namespace=example-namespace",
"x-f5xc-description-short": "Filter to filter the metrics by the given label.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Group By to group the metrics by the given label\n\"name\" is the label name defined in \"PodsMetricLabel\"",
"title": "Group By",
"items": {
"$ref": "#/components/schemas/sitePodsMetricLabel"
},
"x-displayname": "Group By",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "Group By to group the metrics by the given label \"name\" is the label name defined in \"PodsMetricLabel\".",
"x-f5xc-description-medium": "Group By to group the metrics by the given label \"name\" is the label name defined in \"PodsMetricLabel\".",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "array",
"description": "Select metrics to be returned in the response.",
"title": "Metric Selector",
"items": {
"$ref": "#/components/schemas/sitePodsMetricType"
},
"x-displayname": "Metric Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select metrics to be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of cronjobs in a site.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace to scope the listing of cronjobs in a site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"site": {
"type": "string",
"description": "Site name",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "Site-1",
"x-f5xc-example": "site-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-medium": "Start time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for sitePodsMetricsRequest",
"required_fields": [
"metric_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for sitePodsMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  metric_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"metric_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"metric_selector": "value"
}
},
"requiredFields": [
"metric_selector"
],
"description": "Minimum configuration for sitePodsMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "string",
"description": "Filter to filter the metrics by the given label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Group By to group the metrics by the given label\n\"name\" is the label name defined in \"PodsMetricLabel\"",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "array",
"description": "Select metrics to be returned in the response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of cronjobs in a site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site name",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data for the metric types specified in the request."
}
]
}
]
},
	"site-node": {
"name": "site-node",
"displayName": "Site Node",
"operations": [
{
"name": "create_site_node",
"description": "Site Node Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/graph/site/node",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET time-series data for a node in the site graph.\nWhile graph/site API is used to GET application traffic for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/site/node API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.",
      "title": "Site Node Request",
"x-displayname": "Site Node Request.",
"x-ves-proto-message": "ves.io.schema.graph.site.NodeRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"allOf": [
{
"$ref": "#/components/schemas/siteNodeFieldSelector"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"allOf": [
{
"$ref": "#/components/schemas/siteId"
}
],
"x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
"x-f5xc-description-medium": "Namespace is used to scope the application traffic to a given namespace. For system namespace, application traffic across all namespaces for the tenant will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET time-series data for a node in the site graph.",
"x-f5xc-description-medium": "Request to GET time-series data for a node in the site graph. While graph/site API is used to GET application traffic for all sites, where each node and edge contains the aggregated value for each field; graph/site/node API is used to GET the time-series data (drill-down of aggregated data) for...",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteNodeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteNodeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for siteNodeRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "object",
"description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore": {
"type": "object",
"description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.healthscore.types": {
"type": "array",
"description": "Healthscore types to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric": {
"type": "object",
"description": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.downstream": {
"type": "array",
"description": "Downstream refers to the service that sends requests and receives response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.features": {
"type": "array",
"description": "Specify list of timeseries features that should be returned for each metric type\nin the request.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector.metric.upstream": {
"type": "array",
"description": "Upstream refers to the service that receives requests and sends response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id": {
"type": "object",
"description": "ID uniquely identifies a node or an edge in the site graph.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"id.site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "object",
"description": ""
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"site-pods-metrics": {
"name": "site-pods-metrics",
"displayName": "Site Pods Metrics",
"operations": [
{
"name": "create_site_pods_metric",
"description": "Pods Metrics.",
"method": "POST",
"path": "/api/data/namespaces/system/site/{site}/pods/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET Pods Metrics.",
"title": "PodsMetricsRequest",
"x-displayname": "Pods Metrics Request.",
"x-ves-proto-message": "ves.io.schema.site.PodsMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-medium": "End time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "string",
"description": "Filter to filter the metrics by the given label.",
"title": "Filter",
"x-displayname": "Filter",
"x-ves-example": "Namespace=example-namespace.",
"x-f5xc-example": "namespace=example-namespace",
"x-f5xc-description-short": "Filter to filter the metrics by the given label.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Group By to group the metrics by the given label\n\"name\" is the label name defined in \"PodsMetricLabel\"",
"title": "Group By",
"items": {
"$ref": "#/components/schemas/sitePodsMetricLabel"
},
"x-displayname": "Group By",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "Group By to group the metrics by the given label \"name\" is the label name defined in \"PodsMetricLabel\".",
"x-f5xc-description-medium": "Group By to group the metrics by the given label \"name\" is the label name defined in \"PodsMetricLabel\".",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "array",
"description": "Select metrics to be returned in the response.",
"title": "Metric Selector",
"items": {
"$ref": "#/components/schemas/sitePodsMetricType"
},
"x-displayname": "Metric Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select metrics to be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of cronjobs in a site.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace to scope the listing of cronjobs in a site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"site": {
"type": "string",
"description": "Site name",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "Site-1",
"x-f5xc-example": "site-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-medium": "Start time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for sitePodsMetricsRequest",
"required_fields": [
"metric_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for sitePodsMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  metric_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"metric_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"metric_selector": "value"
}
},
"requiredFields": [
"metric_selector"
],
"description": "Minimum configuration for sitePodsMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filters": {
"type": "string",
"description": "Filter to filter the metrics by the given label.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Group By to group the metrics by the given label\n\"name\" is the label name defined in \"PodsMetricLabel\"",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "array",
"description": "Select metrics to be returned in the response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of cronjobs in a site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site name",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data for the metric types specified in the request."
}
]
}
]
},
	"site-status": {
"name": "site-status",
"displayName": "Site Status",
"operations": [
{
"name": "create_site_statu",
"description": "Check Site Exist.",
"method": "POST",
"path": "/api/data/namespaces/system/site/{name}/status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET status for a site.",
"title": "Check Site Exist Request",
"x-displayname": "Check Site Exist Request.",
"x-ves-proto-message": "ves.io.schema.site.CheckSiteExistRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the site.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Ce01",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ce01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteCheckSiteExistRequest",
"required_fields": [
"name"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteCheckSiteExistRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value"
}
},
"requiredFields": [
"name"
],
"description": "Minimum configuration for siteCheckSiteExistRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1": {
"name": "site-v1",
"displayName": "Site V1",
"operations": [
{
"name": "list_site_v1",
"description": "Namespace List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/namespaces",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-configmaps": {
"name": "site-v1-configmaps",
"displayName": "Site V1 Configmaps",
"operations": [
{
"name": "list_site_v1_configmaps",
"description": "ConfigMap List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/configmaps",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items is the list of ConfigMaps."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-endpoints": {
"name": "site-v1-endpoints",
"displayName": "Site V1 Endpoints",
"operations": [
{
"name": "list_site_v1_endpoints",
"description": "Endpoints List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/endpoints",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of endpoints."
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-nodes": {
"name": "site-v1-nodes",
"displayName": "Site V1 Nodes",
"operations": [
{
"name": "list_site_v1_nodes",
"description": "Namespace List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/nodes",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-persistentvolumeclaims": {
"name": "site-v1-persistentvolumeclaims",
"displayName": "Site V1 Persistentvolumeclaims",
"operations": [
{
"name": "list_site_v1_persistentvolumeclaims",
"description": "PersistentVolumeClaim List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/persistentvolumeclaims",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-persistentvolumes": {
"name": "site-v1-persistentvolumes",
"displayName": "Site V1 Persistentvolumes",
"operations": [
{
"name": "list_site_v1_persistentvolumes",
"description": "PersistentVolume List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/persistentvolumes",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-pods": {
"name": "site-v1-pods",
"displayName": "Site V1 Pods",
"operations": [
{
"name": "list_site_v1_pods",
"description": "Pod List",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/pods",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-secrets": {
"name": "site-v1-secrets",
      "displayName": "Site V1 Secrets",
      "operations": [
{
"name": "list_site_v1_secrets",
      "description": "Secret List.",
      "method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/secrets",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-v1-services": {
"name": "site-v1-services",
"displayName": "Site V1 Services",
"operations": [
{
"name": "list_site_v1_services",
"description": "Service List.",
"method": "GET",
"path": "/api/data/namespaces/system/site/{site}/api/v1/services",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "Items in a collection or array"
},
{
"field": "metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"site-virtualmachineinstances-metrics": {
"name": "site-virtualmachineinstances-metrics",
"displayName": "Site Virtualmachineinstances Metrics",
"operations": [
{
"name": "create_site_virtualmachineinstances_metric",
"description": "VirtualMachineInstances Metrics.",
"method": "POST",
"path": "/api/data/namespaces/system/site/{site}/virtualmachineinstances/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET Virtual Machine Instances Metrics.",
"title": "VirtualMachineInstancesMetricsRequest",
"x-displayname": "Virtual Machine Instances Metrics Request.",
"x-ves-proto-message": "ves.io.schema.site.VirtualMachineInstancesMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-medium": "End time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "array",
"description": "Select metrics to be returned in the response.",
"title": "Metric Selector",
"items": {
"$ref": "#/components/schemas/siteVirtualMachineInstancesMetricType"
},
"x-displayname": "Metric Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select metrics to be returned in the response.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of cronjobs in a site.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace to scope the listing of cronjobs in a site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"site": {
"type": "string",
"description": "Site name",
"title": "site",
"x-displayname": "Site",
"x-ves-example": "Site-1",
"x-f5xc-example": "site-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-medium": "Start time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET Virtual Machine Instances Metrics.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteVirtualMachineInstancesMetricsRequest",
"required_fields": [
"metric_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteVirtualMachineInstancesMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  metric_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"metric_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"metric_selector": "value"
}
},
"requiredFields": [
"metric_selector"
],
"description": "Minimum configuration for siteVirtualMachineInstancesMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "array",
"description": "Select metrics to be returned in the response.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to scope the listing of cronjobs in a site.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Site name",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric data.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data for the metric types specified in the request."
}
]
}
]
},
	"sites": {
"name": "sites",
"displayName": "Sites",
"operations": [
{
"name": "replace_site",
"description": "Replace Site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.site.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/schemasiteReplaceSpecType"
}
],
"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 siteReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for siteReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace Site will replace address, coordinates of site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_peer_address": {
"type": "string",
"description": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured\nto fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bgp_router_id": {
"type": "string",
"description": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to\nfetch BGP router ID from site object. This can be used to change router ID per site in a fleet.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_underlay_network": {
"type": "object",
"description": "Optional, virtual network to be used as underlay for different overlay protocols (SRv6, IP-in-IP tunnels for DC Cluster Group)\nDefault is site-local-outside network.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_underlay_network.site_local_inside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_underlay_network.site_local_outside": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.desired_pool_count": {
"type": "integer",
"description": "Desired pool count represent desired number of worker(non master) nodes\nfor manual scaling of public cloud(AWS, GCP, Azure) sites. The desired count\nmust be less than or equal to the maximum size of the scaling group for a\ngiven public cloud. One may also have to increase maximum scaling group size to\neffectively increase desired pool count.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 64,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.inside_nameserver": {
"type": "string",
"description": "Optional IPv4 DNS server to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.inside_vip": {
"type": "string",
"description": "Optional Virtual IP to be used as automatic VIP for site local inside network.\nSee documentation for \"VIP\" in advertise policy to see when Inside VIP is used.\nWhen configured, this is used as VIP (depending on advertise policy configuration).\nWhen not configured, site local inside interface IP will be used as VIP.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.operating_system_version": {
"type": "string",
"description": "Desired Operating System version for this site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outside_nameserver": {
"type": "string",
"description": "Optional IPv4 DNS server to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.outside_vip": {
"type": "string",
"description": "Optional Virtual IP to be used as automatic VIP for site local outside network.\nSee documentation for \"VIP\" in advertise policy to see when Outside VIP is used.\nWhen configured, this is used as VIP (depending on advertise policy configuration).\nWhen not configured, site local interface IP will be used as VIP.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.region": {
"type": "string",
"description": "Cloud Region. A region is a set of datacenters deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_to_site_network_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
},
"spec.site_to_site_tunnel_ip": {
"type": "string",
"description": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_type": {
"type": "string",
"description": "Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL.\nTunnel is of type IPsec\nTunnel is of type SSL.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL"
},
"spec.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.volterra_software_override": {
"type": "string",
"description": "Decide which software version takes effect in case of conflict between site and fleet\n\nSoftware version in site will take precedence.\nBetween site and fleet newer software version will take precedence.\nSoftware version in fleet will take precedence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "SITE_SOFTWARE_OVERRIDE_SITE",
"wireName": "volterra_software_overide"
},
"spec.volterra_software_version": {
"type": "string",
"description": "Desired F5XC software version for this site, a string matching released set of software components.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.default_underlay_network.private_access_choice": [
      "site_local_inside",
"site_local_outside"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
]
}
},
{
"name": "list_sites",
"description": "List Site",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_site",
"description": "GET Site",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"sites-global-kubeconfigs": {
"name": "sites-global-kubeconfigs",
"displayName": "Sites Global Kubeconfigs",
"operations": [
{
"name": "list_sites_global_kubeconfigs",
"description": "List Global Kube Configs.",
"method": "GET",
"path": "/api/web/namespaces/system/sites/{site}/global-kubeconfigs",
      "dangerLevel": "low",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of kubeconfig items."
}
]
},
{
"name": "create_sites_global_kubeconfig",
"description": "Create Global Kube Config.",
"method": "POST",
"path": "/api/web/namespaces/system/sites/{site}/global-kubeconfigs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Create kubeconfig request parameters.",
"title": "Create Global Kube Config Request",
"x-displayname": "Create Kube Config Request.",
"x-ves-proto-message": "ves.io.schema.site.CreateGlobalKubeConfigReq",
"properties": {
"expiration_timestamp": {
"type": "string",
"description": "Timestamp of kubeconfig's certificate expiry.",
"title": "Expiry timestamp",
"format": "date-time",
"x-displayname": "Expiry timestamp.",
"x-ves-example": "Value",
"x-ves-validation-rules": {
"ves.io.schema.rules.timestamp.gt_now": "true",
"ves.io.schema.rules.timestamp.within.seconds": "31536000"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.timestamp.gt_now": "true",
"ves.io.schema.rules.timestamp.within.seconds": "31536000"
},
"x-f5xc-description-short": "Timestamp of kubeconfig's certificate expiry.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which kubeconfig is being requested.",
"title": "Site",
"minLength": 1,
"maxLength": 64,
"x-displayname": "Site",
"x-ves-example": "Ce398",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-example": "ce398",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_bytes": "64",
"ves.io.schema.rules.string.min_bytes": "1"
},
"x-f5xc-description-short": "Name of the site for which kubeconfig is being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"byteLength": {
"max": 64,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteCreateGlobalKubeConfigReq",
"required_fields": [
"site"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteCreateGlobalKubeConfigReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  site: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"site\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"site": "value"
}
},
"requiredFields": [
"site"
],
"description": "Minimum configuration for siteCreateGlobalKubeConfigReq"
},
"fieldMetadata": {
"expiration_timestamp": {
"type": "string",
"description": "Timestamp of kubeconfig's certificate expiry.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site for which kubeconfig is being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 64,
"byteLength": {
"max": 64,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"srv6-network-slices": {
"name": "srv6-network-slices",
"displayName": "Srv6 Network Slices",
"operations": [
{
"name": "create_srv6_network_slice",
"description": "Create SRv6 Network Slice.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/srv6_network_slices",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of srv6_network_slice",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.srv6_network_slice.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/schemasrv6_network_sliceCreateSpecType"
}
],
"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 srv6_network_sliceCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for srv6_network_sliceCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for srv6_network_sliceCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create srv6_network_slice creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_access_networks": {
      "type": "boolean",
"description": "Connect all SRv6 Virtual Networks in this slice to their corresponding access networks by importing route\ntargets specified in the virtual network.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_enterprise_networks": {
"type": "boolean",
"description": "Connect all SRv6 Virtual Networks in this slice to their corresponding enterprise networks by importing route\ntargets specified in the virtual network.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_internet": {
"type": "boolean",
"description": "Connect all SRv6 Virtual Networks in this slice to the Internet by importing route targets specified in the\nvirtual network.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sid_prefixes": {
"type": "array",
"description": "A SID Locator from the prefix is allocated automatically for each node in each site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_srv6_network_slice",
"description": "Replace SRv6 Network Slice.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/srv6_network_slices/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a srv6_network_slice",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.srv6_network_slice.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/schemasrv6_network_sliceReplaceSpecType"
}
],
"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 srv6_network_sliceReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for srv6_network_sliceReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for srv6_network_sliceReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace srv6_network_slice replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_access_networks": {
      "type": "boolean",
"description": "Connect all SRv6 Virtual Networks in this slice to their corresponding access networks by importing route\ntargets specified in the virtual network.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_enterprise_networks": {
"type": "boolean",
"description": "Connect all SRv6 Virtual Networks in this slice to their corresponding enterprise networks by importing route\ntargets specified in the virtual network.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_internet": {
"type": "boolean",
"description": "Connect all SRv6 Virtual Networks in this slice to the Internet by importing route targets specified in the\nvirtual network.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sid_prefixes": {
"type": "array",
"description": "A SID Locator from the prefix is allocated automatically for each node in each site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 1,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_srv6_network_slices",
"description": "List SRv6 Network Slice.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/srv6_network_slices",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_srv6_network_slice",
"description": "DELETE SRv6 Network Slice.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/srv6_network_slices/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a srv6_network_slice",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.srv6_network_slice.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for srv6_network_sliceDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for srv6_network_sliceDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_srv6_network_slice",
"description": "GET SRv6 Network Slice.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/srv6_network_slices/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"staged-signatures": {
"name": "staged-signatures",
"displayName": "Staged Signatures",
"operations": [
{
"name": "create_staged_signature",
"description": "Staged Signatures.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{vh_name}/staged_signatures",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "vh_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the list of all staged signatures.",
"title": "StagedSignaturesReq",
"x-displayname": "Staged Signatures Request.",
"x-ves-proto-message": "ves.io.schema.waf_signatures_changelog.StagedSignaturesReq",
"properties": {
"end_time": {
"type": "string",
"description": "Fetch staged signatures whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339.",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-f5xc-description-short": "Fetch staged signatures whose timestamp <= end_time format: unix_timestamp|RFC 3339.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch staged signatures for the given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Fetch staged signatures for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Fetch staged signatures whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-f5xc-description-short": "Fetch staged signatures whose timestamp >= start_time format: unix_timestamp|RFC 3339.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vh_name": {
"type": "string",
"description": "Virtual Host for current request.",
"title": "vh_name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET the list of all staged signatures.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for waf_signatures_changelogStagedSignaturesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for waf_signatures_changelogStagedSignaturesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"staged_signatures": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for waf_signatures_changelogStagedSignaturesReq"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "Fetch staged signatures whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch staged signatures for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch staged signatures whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vh_name": {
"type": "string",
"description": "Virtual Host for current request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "staged_signatures",
"type": "array",
"description": "List of staged signatures."
}
]
}
]
},
	"static-components": {
"name": "static-components",
"displayName": "Static Components",
"operations": [
{
"name": "list_static_components",
"description": "List UI Static Component.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/static_components",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_static_component",
"description": "GET UI static component.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/static_components/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"static-tenant-settings-tenant-favicon": {
"name": "static-tenant-settings-tenant-favicon",
"displayName": "Static Tenant Settings Tenant Favicon",
"operations": [
{
"name": "list_static_tenant_settings_tenant_favicon",
"description": "Tenant favicon.",
"method": "GET",
"path": "/api/web/static/namespaces/system/tenant/settings/tenant/favicon",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"static-tenant-settings-tenant-image": {
"name": "static-tenant-settings-tenant-image",
"displayName": "Static Tenant Settings Tenant Image",
"operations": [
{
"name": "list_static_tenant_settings_tenant_image",
"description": "Tenant profile image.",
"method": "GET",
"path": "/api/web/static/namespaces/system/tenant/settings/tenant/image",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"stats": {
"name": "stats",
"displayName": "Stats",
"operations": [
{
"name": "create_stat",
"description": "GET API Endpoints Stats for Namespace.",
      "method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/api_endpoints/stats",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for GET API Endpoints Stats.",
      "title": "Api Endpoints stats request",
      "x-displayname": "API Endpoints Stats Request.",
      "x-ves-proto-message": "ves.io.schema.namespace.ApiEndpointsStatsNSReq",
      "properties": {
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"vhosts_filter": {
"type": "array",
"description": "List of Virtual Hosts for current request\nIf the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.",
"title": "List Of Virtual Hosts Name",
"items": {
"type": "string"
},
"x-displayname": "List Of Virtual Hosts Name.",
"x-ves-example": "Blogging-app, test-app.",
"x-f5xc-example": "blogging-app, test-app",
"x-f5xc-description-short": "List of Virtual Hosts for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested...",
"x-f5xc-description-medium": "List of Virtual Hosts for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vhosts_types_filter": {
"type": "array",
"description": "List of Virtual Hosts types for current request\nIf the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.",
"title": "Virtual Hosts Types Filter",
"items": {
"$ref": "#/components/schemas/virtual_hostVirtualHostType"
},
"x-displayname": "Virtual Hosts Types Filter.",
"x-ves-validation-rules": {
"ves.io.schema.rules.enum.in": "[1,6,7,8]",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "[\"HTTP_LOAD_BALANCER\", \"CDN_LOAD_BALANCER\"]",
"x-validation-rules": {
"ves.io.schema.rules.enum.in": "[1,6,7,8]",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "List of Virtual Hosts types for current request If the list is empty or not provided, it will return stats for all virtual hosts under the...",
"x-f5xc-description-medium": "List of Virtual Hosts types for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request shape for GET API Endpoints Stats.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceApiEndpointsStatsNSReq",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceApiEndpointsStatsNSReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"discovered": {
"type": "integer"
},
"inventory": {
"type": "integer"
},
"pii_detected": {
"type": "integer"
},
"shadow": {
"type": "integer"
},
"total_endpoints": {
"type": "integer"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceApiEndpointsStatsNSReq"
      },
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vhosts_filter": {
"type": "array",
"description": "List of Virtual Hosts for current request\nIf the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vhosts_types_filter": {
"type": "array",
"description": "List of Virtual Hosts types for current request\nIf the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "discovered",
"type": "integer",
"description": "Number of endpoints that categorized as discover."
},
{
"field": "inventory",
"type": "integer",
"description": "Number of endpoints that categorized as inventory."
},
{
"field": "pii_detected",
"type": "integer",
"description": "Number of endpoints that detected with pii."
},
{
"field": "shadow",
"type": "integer",
"description": "Number of endpoints that categorized as shadow."
},
{
"field": "total_endpoints",
"type": "integer",
"description": "Total endpoints."
}
]
}
]
},
	"status": {
"name": "status",
"displayName": "Status",
"operations": [
{
"name": "list_status",
"description": "GET Status of Terraform for view.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/terraform_parameters/{view_kind}/{view_name}/status",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "view_kind",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "view_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "status",
"type": "object",
"description": ""
}
]
},
{
"name": "create_statu",
"description": "Global Log Receiver Status.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/global_log_receiver/status",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET the global log receiver.",
"title": "Global Log Receiver Status Request",
"x-displayname": "Global Log Receiver Status Request.",
"x-ves-proto-message": "ves.io.schema.global_log_receiver.GlobalLogReceiverStatusRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end_time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/schemaglobal_log_receiverLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by labels specified in the group_by field.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, glr status data for all global log receiver will be returned in the response.",
      "title": "label_filter",
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/global_log_receiverLabelFilter"
},
"x-displayname": "Label Filter.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "100"
},
"x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
      "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, glr status data for all global log receiver will be returned in the response.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the configured object.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bookinfo",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "bookinfo",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build response.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start_time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build response.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build response. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for global_log_receiverGlobalLogReceiverStatusRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for global_log_receiverGlobalLogReceiverStatusRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "log"
},
"responseSchema": {
"type": "object",
"properties": {
"glr_status": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for global_log_receiverGlobalLogReceiverStatusRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by labels specified in the group_by field.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"label_filter": {
"type": "array",
"description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, glr status data for all global log receiver will be returned in the response.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the configured object.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build response.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "glr_status",
"type": "array",
"description": "Status data specified for the global log receiver."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"status-at-site": {
"name": "status-at-site",
"displayName": "Status At Site",
"operations": [
{
"name": "list_status_at_site",
"description": "GET Status.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/{kind}/{name}/status_at_site",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "kind",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "site",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "site_type",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"conditions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "conditions",
"type": "array",
"description": "List of conditions for the requested object in a given site."
},
{
"field": "error",
"type": "object",
"description": ""
}
]
}
]
},
	"status-metrics": {
"name": "status-metrics",
"displayName": "Status Metrics",
"operations": [
{
"name": "create_status_metric",
"description": "Site Status Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/site/{site}/status/metrics",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET status metrics for a site.",
"title": "Site Status Metrics Request",
"x-displayname": "Site Status Metrics Request.",
"x-ves-proto-message": "ves.io.schema.site.SiteStatusMetricsRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "List of fields to be returned in the response.",
"title": "Field Selector",
"items": {
"$ref": "#/components/schemas/siteSiteStatusMetricsField"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "List of fields to be returned in the response.",
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Only system namespace is valid for this request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Only system namespace is valid for this request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site",
"x-displayname": "Site",
"x-ves-example": "Ce01",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ce01",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "15m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "15m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET status metrics for a site.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteSiteStatusMetricsRequest",
"required_fields": [
"field_selector",
"namespace",
"site"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteSiteStatusMetricsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value\n  namespace: value\n  site: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\",\n    \"namespace\": \"value\",\n    \"site\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value",
"namespace": "value",
"site": "value"
}
},
"requiredFields": [
"field_selector",
"namespace",
"site"
],
"description": "Minimum configuration for siteSiteStatusMetricsRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "List of fields to be returned in the response.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Only system namespace is valid for this request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series data for the status fields in the request."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"storage-set-vpc-k8s-hostnames": {
"name": "storage-set-vpc-k8s-hostnames",
"displayName": "Storage Set Vpc K8S Hostnames",
"operations": [
{
"name": "create_storage_set_vpc_k8s_hostname",
"description": "Configure VPC K8s hostnames.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_vpc_site/{name}/storage/set_vpc_k8s_hostnames",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to configure VPC K8s node hostname set.",
"title": "Request to configure VPC k8s node hostname set",
"x-displayname": "Request to configure VPC K8s node hostname set.",
"x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetVPCK8SHostnamesRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-VPC-site-1.",
"x-f5xc-example": "aws-vpc-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"node_names": {
"type": "array",
"description": "Hostname of K8s nodes for definition of Mayastore pools.",
"title": "Hostname of K8S nodes",
"items": {
"type": "string"
},
"x-displayname": "Hostname of K8s nodes.",
"x-ves-example": "Master-0",
"x-f5xc-example": "master-0",
"x-f5xc-description-short": "Hostname of K8s nodes for definition of Mayastore pools.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to configure VPC K8s node hostname set.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for aws_vpc_siteSetVPCK8SHostnamesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for aws_vpc_siteSetVPCK8SHostnamesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for aws_vpc_siteSetVPCK8SHostnamesRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node_names": {
"type": "array",
"description": "Hostname of K8s nodes for definition of Mayastore pools.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"subnets": {
"name": "subnets",
"displayName": "Subnets",
"operations": [
{
"name": "create_subnet",
"description": "Create Subnet.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/subnets",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of subnet",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.subnet.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/schemasubnetCreateSpecType"
}
],
"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 subnetCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subnetCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subnetCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Subnet object contains configuration for an interface of a VM/pod.\nIt is created in user or shared namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_layer2": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_layer2.layer2_intf_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_slo": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.isolated_nw": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_subnet_params": {
"type": "array",
"description": "Configure subnet parameters per site.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.connection_choice": [
"connect_to_layer2",
"connect_to_slo",
"isolated_nw"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_subnet",
"description": "Replace Subnet.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/subnets/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a subnet",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.subnet.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/schemasubnetReplaceSpecType"
}
],
"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 subnetReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subnetReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for subnetReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of subnet specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_layer2": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_layer2.layer2_intf_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connect_to_slo": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.isolated_nw": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.connection_choice": [
"connect_to_layer2",
"connect_to_slo",
"isolated_nw"
]
}
},
{
"name": "list_subnets",
"description": "List Subnet.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/subnets",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_subnet",
"description": "DELETE Subnet.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/subnets/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a subnet",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.subnet.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for subnetDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for subnetDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_subnet",
"description": "GET Subnet.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/subnets/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"suggest-values": {
"name": "suggest-values",
"displayName": "Suggest Values",
"operations": [
{
"name": "create_suggest_value",
"description": "Suggest Values.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/suggest-values",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request body of SuggestValues request.",
"title": "SuggestValuesReq",
"x-displayname": "Request for SuggestValues.",
"x-ves-proto-message": "ves.io.schema.namespace.SuggestValuesReq",
"properties": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"title": "field_path",
"maxLength": 1024,
"x-displayname": "Field Path.",
"x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.",
      "x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match",
      "x-validation-rules": {
"ves.io.schema.rules.string.max_len": "1024"
},
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"title": "match_value",
"maxLength": 256,
"x-displayname": "Match Value.",
"x-ves-example": "Some-substring.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "some-substring",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Foobar",
"x-f5xc-example": "foobar",
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"request_body": {
"allOf": [
{
"$ref": "#/components/schemas/protobufAny"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceSuggestValuesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceSuggestValuesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceSuggestValuesReq"
},
"fieldMetadata": {
"field_path": {
"type": "string",
"description": "JSON path of the field for which the suggested values are being requested.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"match_value": {
"type": "string",
"description": "A substring that must be present in either the value or description of each SuggestedItem in the response.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the suggestions are scoped.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body": {
"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\": <string>,\n\"lastName\": <string>\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}",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.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.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"request_body.value": {
"type": "string",
"description": "Must be a valid serialized protocol buffer of the above specified type.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List of suggested items."
}
]
}
]
},
	"support-tenant-managed-tenants": {
"name": "support-tenant-managed-tenants",
"displayName": "Support Tenant Managed Tenants",
"operations": [
{
"name": "list_support_tenant_managed_tenants",
"description": "List of Managed Tenant By User For Support Operations.",
"method": "GET",
"path": "/api/web/namespaces/system/support-tenant/managed_tenants",
      "dangerLevel": "low",
"parameters": [
{
"name": "search_keyword",
      "in": "query",
"required": false,
"type": "string"
},
{
"name": "page_start",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "page_limit",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"items": {
"type": "array"
},
"next_page": {
"type": "string"
},
"total_count": {
"type": "integer"
},
"total_filtered_count": {
"type": "integer"
}
}
},
"responseSummary": [
{
"field": "items",
"type": "array",
"description": "List support tenant MT items."
},
{
"field": "next_page",
"type": "string",
"description": "NextPage contains the UUID of the first item of the next page.\nThis value can be passed back as the PageStart in the next request.\nIf this empty means current one is the last page."
},
{
"field": "total_count",
"type": "integer",
"description": "TotalCount holds total count of access config."
      },
{
"field": "total_filtered_count",
"type": "integer",
"description": "TotalFilteredCount holds total count of access config after filtering."
      }
]
}
]
},
	"suspicious-user-logs": {
"name": "suspicious-user-logs",
"displayName": "Suspicious User Logs",
"operations": [
{
"name": "create_suspicious_user_log",
"description": "Suspicious User Logs Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/suspicious_user_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch suspicious user logs.",
"title": "Suspicious User Logs Request",
"x-displayname": "Suspicious User Logs Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SuspiciousUserLogsRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the suspicious user logs response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch suspicious user logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be...",
"x-f5xc-description-medium": "Fetch suspicious user logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 logs that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 logs that matches the query (depending on the...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 logs that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch suspicious user logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch suspicious user logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the suspicious user logs may be specified in the query.\nVh_name - name of the virtual host\nuser - user ID\nsite - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then suspicious user logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the suspicious user logs matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={vh_name=\"vh-1\", site=\"CE-01\"}",
"x-f5xc-example": "\"query={vh_name=\"vh-1\", site=\"ce-01\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the suspicious user logs may be specified in the query. Vh_name - name of the virtual host user - user ID site ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of logs (or all logs) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no logs left to return. The number of logs in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of logs (or all logs) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of logs (or all logs) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no logs left to return. The number of logs in each batch is determined by...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"title": "sort by",
"x-displayname": "Sort By",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Optional: default is sort by last_event_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/app_securitySearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch suspicious user logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch suspicious user logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySuspiciousUserLogsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySuspiciousUserLogsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySuspiciousUserLogsRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 logs that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch suspicious user logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the suspicious user logs may be specified in the query.\nVh_name - name of the virtual host\nuser - user ID\nsite - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then suspicious user logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the suspicious user logs matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of logs (or all logs) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no logs left to return. The number of logs in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_by": {
"type": "string",
"description": "Optional: default is sort by last_event_time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Contains no more than 500 messages."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of suspicious user logs using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SuspiciousUserLogsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of logs that matched the query."
}
]
}
]
},
	"suspicious-user-logs-aggregation": {
"name": "suspicious-user-logs-aggregation",
"displayName": "Suspicious User Logs Aggregation",
"operations": [
{
"name": "create_suspicious_user_logs_aggregation",
"description": "Suspicious User Logs Aggregation Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/suspicious_user_logs/aggregation",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET only aggregation data for suspicious user logs.",
"title": "Suspicious User Logs Aggregation Request",
"x-displayname": "Suspicious User Logs Aggregation Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SuspiciousUserLogsAggregationRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the suspicious user logs response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch suspicious user logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be...",
"x-f5xc-description-medium": "Fetch suspicious user logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch suspicious user logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch suspicious user logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the suspicious user logs may be specified in the query.\nVh_name - name of the virtual host\nuser - user ID\nsite - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then suspicious user logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the suspicious user logs matching the given tenant and namespace will be returned in the response.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={vh_name=\"vh-1\", site=\"CE-01\"}",
"x-f5xc-example": "\"query={vh_name=\"vh-1\", site=\"ce-01\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of these fields in the suspicious user logs may be specified in the query. Vh_name - name of the virtual host user - user ID site ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570007981.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570007981",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch suspicious user logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...",
"x-f5xc-description-medium": "Fetch suspicious user logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET only aggregation data for suspicious user logs.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySuspiciousUserLogsAggregationRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySuspiciousUserLogsAggregationRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySuspiciousUserLogsAggregationRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch suspicious user logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of these fields in the suspicious user logs may be specified in the query.\nVh_name - name of the virtual host\nuser - user ID\nsite - source site\ncity - name of the city\ncountry - country code\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then suspicious user logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the suspicious user logs matching the given tenant and namespace will be returned in the response.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch suspicious user logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the suspicious user logs response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "total_hits",
"type": "string",
"description": "Total number of suspicious user logs that matched the query."
}
]
}
]
},
	"suspicious-user-logs-scroll": {
"name": "suspicious-user-logs-scroll",
"displayName": "Suspicious User Logs Scroll",
"operations": [
{
"name": "list_suspicious_user_logs_scroll",
"description": "Suspicious User Logs Scroll Query.",
"method": "GET",
"path": "/api/data/namespaces/{namespace}/app_security/suspicious_user_logs/scroll",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "scroll_id",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Contains no more than 500 messages."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of suspicious user logs using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SuspiciousUserLogsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of logs that matched the query."
}
]
},
{
"name": "create_suspicious_user_logs_scroll",
"description": "Suspicious User Logs Scroll Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/app_security/suspicious_user_logs/scroll",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Scroll request is used to fetch large number of suspicious user logs in multiple batches with each SuspiciousUserLogsResponse\ncontaining no more than 500 messages. To scroll through more than 500 or all messages, one can use the\nSuspiciousUserLogsScrollRequest. Use the scroll_id returned in the SuspiciousUserLogsResponse to fetch the next batch of logs\nand one can continue this process till the scroll_id returned is \"\" which indicates no more logs to scroll.",
"title": "Suspicious User Logs Scroll Request",
"x-displayname": "Suspicious User Logs Scroll Request.",
"x-ves-proto-message": "ves.io.schema.app_security.SuspiciousUserLogsScrollRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Fetch the next batch of suspicious user logs scoped by namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Bloggin-app-namespace-1.",
"x-f5xc-example": "bloggin-app-namespace-1",
"x-f5xc-description-short": "Fetch the next batch of suspicious user logs scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"title": "scroll id",
"x-displayname": "Scroll ID",
"x-ves-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==.",
"x-f5xc-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Scroll request is used to fetch large number of suspicious user logs in multiple batches with each SuspiciousUserLogsResponse containing no more...",
"x-f5xc-description-medium": "Scroll request is used to fetch large number of suspicious user logs in multiple batches with each SuspiciousUserLogsResponse containing no more than 500 messages. To scroll through more than 500 or all messages, one can use the SuspiciousUserLogsScrollRequest. Use the scroll_id returned in the...",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securitySuspiciousUserLogsScrollRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securitySuspiciousUserLogsScrollRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securitySuspiciousUserLogsScrollRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Fetch the next batch of suspicious user logs scoped by namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll_id": {
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the security events response. If the number of security events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations."
},
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Contains no more than 500 messages."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve the next batch of suspicious user logs using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the SuspiciousUserLogsResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of logs that matched the query."
}
]
}
]
},
	"suspicious-users": {
"name": "suspicious-users",
"displayName": "Suspicious Users",
"operations": [
{
"name": "list_suspicious_users",
"description": "GET Status of Suspicious users.",
"method": "GET",
"path": "/api/ml/data/namespaces/{namespace}/app_settings/{name}/suspicious_users",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "query",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "start_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "end_time",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "topn",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"suspicious_users": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "suspicious_users",
"type": "array",
"description": "List of suspicious users."
}
]
}
]
},
	"sync-cloud-data-cloud-connect-reapply-vpc-attachment": {
"name": "sync-cloud-data-cloud-connect-reapply-vpc-attachment",
"displayName": "Sync Cloud Data Cloud Connect Reapply Vpc Attachment",
"operations": [
{
"name": "create_sync_cloud_data_cloud_connect_reapply_vpc_attachment",
"description": "ReApplyVPCAttachment.",
"method": "POST",
"path": "/api/sync-cloud-data/namespaces/system/cloud_connect_reapply_vpc_attachment",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request of VPC attachment reapply event.",
"title": "ReApplyVPCAttachmentRequest",
"x-displayname": "ReApplyVPCAttachmentRequest.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.ReApplyVPCAttachmentRequest",
"properties": {
"cloud_connect": {
"allOf": [
{
"$ref": "#/components/schemas/schemaviewsObjectRefType"
}
],
"x-f5xc-description-short": "Configuration parameter for cloud connect.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/cloud_connectCloudConnectProviderType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"vpc_id": {
"type": "string",
"description": "VPC ID",
"title": "VPC ID",
"x-displayname": "VPC ID",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "Request of VPC attachment reapply event.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectReApplyVPCAttachmentRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectReApplyVPCAttachmentRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectReApplyVPCAttachmentRequest"
},
"fieldMetadata": {
"cloud_connect": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cloud_connect.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"cloud_connect.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cloud_connect.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"provider": {
"type": "string",
"description": "Cloud Connect Provider Type\n\n- AWS: AWS\n\nCloud connects backed by AWS cloud\n- Azure: Azure\n\nCloud connects backed by Azure cloud\n- GCP: GCP\n\nCloud connects backed by GCP cloud.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AWS"
},
"vpc_id": {
"type": "string",
"description": "VPC ID",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"sync-cloud-data-discover-vpc": {
"name": "sync-cloud-data-discover-vpc",
"displayName": "Sync Cloud Data Discover Vpc",
"operations": [
{
"name": "create_sync_cloud_data_discover_vpc",
"description": "Cloud Connect VPC Discovery.",
"method": "POST",
"path": "/api/sync-cloud-data/namespaces/system/discover_vpc",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body to discover vpcs for a given cloud provider, region and cred.",
"title": "DiscoverVPCRequest",
"x-displayname": "Cloud Connect VPC Discovery Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.DiscoverVPCRequest",
"properties": {
"cred": {
"allOf": [
{
"$ref": "#/components/schemas/schemaviewsObjectRefType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site": {
"allOf": [
{
"$ref": "#/components/schemas/ioschemaObjectRefType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/cloud_connectCloudConnectProviderType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"region": {
"type": "string",
"description": "Region.",
"title": "Region",
"x-displayname": "Region",
"x-f5xc-example": "us-west-2",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request body to discover vpcs for a given cloud provider, region and cred.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectDiscoverVPCRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectDiscoverVPCRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {
"discovered_vpc": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for cloud_connectDiscoverVPCRequest"
},
"fieldMetadata": {
"cred": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"cred.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"cred.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site": {
"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)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site.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\")",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site.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.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site.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.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"edge_site.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.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"provider": {
"type": "string",
"description": "Cloud Connect Provider Type\n\n- AWS: AWS\n\nCloud connects backed by AWS cloud\n- Azure: Azure\n\nCloud connects backed by Azure cloud\n- GCP: GCP\n\nCloud connects backed by GCP cloud.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "AWS"
},
"region": {
"type": "string",
"description": "Region.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "discovered_vpc",
"type": "array",
"description": "Discovered VPC."
}
]
}
]
},
	"sync-cloud-data-securemesh-site-v2-cloud-resources": {
"name": "sync-cloud-data-securemesh-site-v2-cloud-resources",
"displayName": "Sync Cloud Data Securemesh Site V2 Cloud Resources",
"operations": [
{
"name": "list_sync_cloud_data_securemesh_site_v2_cloud_resources",
"description": "List Cloud Resources.",
"method": "GET",
"path": "/api/sync-cloud-data/namespaces/system/securemesh_site_v2/{site_name}/cloud_resources",
      "dangerLevel": "low",
"parameters": [
{
"name": "site_name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "deletion",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "aws_cloud_resources",
"type": "object",
"description": ""
}
]
}
]
},
	"tcp-loadbalancers": {
"name": "tcp-loadbalancers",
"displayName": "Tcp Loadbalancers",
"operations": [
{
"name": "create_tcp_loadbalancer",
"description": "Create TCP Load Balancer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/tcp_loadbalancers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of tcp_loadbalancer",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.tcp_loadbalancer.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/viewstcp_loadbalancerCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "TCP load balancer for non-HTTP protocols",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.listen_port",
"spec.origin_pools_weights"
],
"mutually_exclusive_groups": [
{
"name": "port_choice",
"fields": [
"spec.listen_port",
"spec.port_ranges"
],
"reason": "Specify either a single port or port ranges"
},
{
"name": "advertising",
"fields": [
"spec.do_not_advertise",
"spec.advertise_on_public_default_vip",
"spec.advertise_on_public",
"spec.advertise_custom"
],
"reason": "Choose exactly one advertising method"
},
{
"name": "hash_policy",
"fields": [
"spec.hash_policy_choice_least_active",
"spec.hash_policy_choice_random",
"spec.hash_policy_choice_round_robin",
"spec.hash_policy_choice_source_ip_stickiness"
],
"reason": "Choose load balancing hash policy"
},
{
"name": "protocol",
"fields": [
"spec.tcp",
"spec.tls_tcp",
"spec.tls_tcp_auto_cert"
],
"reason": "Choose TCP or TLS protocol"
},
{
"name": "sni",
"fields": [
"spec.no_sni",
"spec.sni"
],
"reason": "SNI matching or none"
},
{
"name": "service_policies",
"fields": [
"spec.service_policies_from_namespace",
"spec.no_service_policies"
],
"reason": "Service policies from namespace or none"
}
],
"example_yaml": "apiVersion: v1\nkind: tcp_loadbalancer\nmetadata:\n  name: example-tcp-lb\n  namespace: default\nspec:\n  listen_port: 80\n  do_not_advertise: {}\n  origin_pools_weights:\n    - pool:\n        namespace: default\n        name: backend-pool\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-tcp-lb\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"listen_port\": 80,\n    \"do_not_advertise\": {},\n    \"origin_pools_weights\": [{\"pool\": {\"namespace\": \"{{PREREQ_POOL_NS}}\", \"name\": \"{{PREREQ_POOL}}\"}, \"weight\": 1}]\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-tcp-lb",
"namespace": "default"
},
"spec": {
"listen_port": 80,
"do_not_advertise": {},
"origin_pools_weights": [
{
"pool": {
"namespace": "{{PREREQ_POOL_NS}}",
"name": "{{PREREQ_POOL}}"
},
"weight": 1
}
]
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.listen_port",
"spec.origin_pools_weights"
],
"description": "TCP load balancer for non-HTTP protocols"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the TCP load balancer create specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public.public_ip": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_lb_with_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nThis requires the domain to be delegated to F5XC using the Delegated Domain feature.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_retract_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of Domains (host/authority header) that will be matched to this Load Balancer.\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.\n\nDomains are also used for SNI matching if SNI is activated on the given TCP Load Balancer.\nDomains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_least_active": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_random": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_source_ip_stickiness": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.idle_timeout": {
"type": "integer",
"description": "The amount of time that a stream can exist without upstream or downstream activity, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 4147200000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.listen_port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nListen Port for this load balancer.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools_weights": {
"type": "array",
"description": "Origin pools and weights used for this load balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_ranges": {
"type": "string",
"description": "Exclusive with [listen_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retract_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp": {
"type": "object",
"description": "Choice for selecting TLS over TCP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp.tls_cert_params": {
"type": "object",
"description": "Select TLS Parameters and Certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp.tls_parameters": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert": {
"type": "object",
"description": "Choice for selecting TLS over TCP proxy with automatic certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert.no_mtls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert.use_mtls": {
"type": "object",
"description": "Validation context for downstream client TLS connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
],
"spec.cluster_retract_choice": [
"do_not_retract_cluster",
"retract_cluster"
],
"spec.hash_policy_choice": [
"hash_policy_choice_least_active",
"hash_policy_choice_random",
"hash_policy_choice_round_robin",
"hash_policy_choice_source_ip_stickiness"
],
"spec.loadbalancer_type": [
"tcp",
"tls_tcp",
"tls_tcp_auto_cert"
],
"spec.port_choice": [
"listen_port",
"port_ranges"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
],
"spec.sni_default_lb_choice": [
"default_lb_with_sni",
"no_sni",
"sni"
],
"spec.tls_tcp.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.tls_tcp.tls_cert_params.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.tls_tcp.tls_parameters.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.tls_tcp_auto_cert.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.tls_tcp_auto_cert.tls_config.choice": [
"custom_security",
"default_security",
"low_security",
"medium_security"
],
"spec.tls_tcp_auto_cert.use_mtls.crl_choice": [
"crl",
"no_crl"
],
"spec.tls_tcp_auto_cert.use_mtls.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
],
"spec.tls_tcp_auto_cert.use_mtls.xfcc_header": [
"xfcc_disabled",
"xfcc_options"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tcp_loadbalancer",
"description": "Replace TCP Load Balancer.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/tcp_loadbalancers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a tcp_loadbalancer",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.tcp_loadbalancer.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/viewstcp_loadbalancerReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "TCP load balancer for non-HTTP protocols",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.listen_port",
"spec.origin_pools_weights"
],
"mutually_exclusive_groups": [
{
"name": "port_choice",
"fields": [
"spec.listen_port",
"spec.port_ranges"
],
"reason": "Specify either a single port or port ranges"
},
{
"name": "advertising",
"fields": [
"spec.do_not_advertise",
"spec.advertise_on_public_default_vip",
"spec.advertise_on_public",
"spec.advertise_custom"
],
"reason": "Choose exactly one advertising method"
},
{
"name": "hash_policy",
"fields": [
"spec.hash_policy_choice_least_active",
"spec.hash_policy_choice_random",
"spec.hash_policy_choice_round_robin",
"spec.hash_policy_choice_source_ip_stickiness"
],
"reason": "Choose load balancing hash policy"
},
{
"name": "protocol",
"fields": [
"spec.tcp",
"spec.tls_tcp",
"spec.tls_tcp_auto_cert"
],
"reason": "Choose TCP or TLS protocol"
},
{
"name": "sni",
"fields": [
"spec.no_sni",
"spec.sni"
],
"reason": "SNI matching or none"
},
{
"name": "service_policies",
"fields": [
"spec.service_policies_from_namespace",
"spec.no_service_policies"
],
"reason": "Service policies from namespace or none"
}
],
"example_yaml": "apiVersion: v1\nkind: tcp_loadbalancer\nmetadata:\n  name: example-tcp-lb\n  namespace: default\nspec:\n  listen_port: 80\n  do_not_advertise: {}\n  origin_pools_weights:\n    - pool:\n        namespace: default\n        name: backend-pool\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-tcp-lb\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"listen_port\": 80,\n    \"do_not_advertise\": {},\n    \"origin_pools_weights\": [{\"pool\": {\"namespace\": \"{{PREREQ_POOL_NS}}\", \"name\": \"{{PREREQ_POOL}}\"}, \"weight\": 1}]\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-tcp-lb",
"namespace": "default"
},
"spec": {
"listen_port": 80,
"do_not_advertise": {},
"origin_pools_weights": [
{
"pool": {
"namespace": "{{PREREQ_POOL_NS}}",
"name": "{{PREREQ_POOL}}"
},
"weight": 1
}
]
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.listen_port",
"spec.origin_pools_weights"
],
"description": "TCP load balancer for non-HTTP protocols"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the TCP load balancer replace specification.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public.public_ip": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_lb_with_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nThis requires the domain to be delegated to F5XC using the Delegated Domain feature.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_retract_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of Domains (host/authority header) that will be matched to this Load Balancer.\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.\n\nDomains are also used for SNI matching if SNI is activated on the given TCP Load Balancer.\nDomains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_least_active": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_random": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_source_ip_stickiness": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.idle_timeout": {
"type": "integer",
"description": "The amount of time that a stream can exist without upstream or downstream activity, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 4147200000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.listen_port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nListen Port for this load balancer.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools_weights": {
"type": "array",
"description": "Origin pools and weights used for this load balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_ranges": {
"type": "string",
"description": "Exclusive with [listen_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retract_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sni": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tcp": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp": {
"type": "object",
"description": "Choice for selecting TLS over TCP proxy with bring your own certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp.tls_cert_params": {
"type": "object",
"description": "Select TLS Parameters and Certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp.tls_parameters": {
"type": "object",
"description": "Inline TLS parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert": {
"type": "object",
"description": "Choice for selecting TLS over TCP proxy with automatic certificates.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert.no_mtls": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert.tls_config": {
"type": "object",
"description": "This defines various OPTIONS to configure TLS configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_tcp_auto_cert.use_mtls": {
"type": "object",
"description": "Validation context for downstream client TLS connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
],
"spec.cluster_retract_choice": [
"do_not_retract_cluster",
"retract_cluster"
],
"spec.hash_policy_choice": [
"hash_policy_choice_least_active",
"hash_policy_choice_random",
"hash_policy_choice_round_robin",
"hash_policy_choice_source_ip_stickiness"
],
"spec.loadbalancer_type": [
"tcp",
"tls_tcp",
"tls_tcp_auto_cert"
],
"spec.port_choice": [
"listen_port",
"port_ranges"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
],
"spec.sni_default_lb_choice": [
"default_lb_with_sni",
"no_sni",
"sni"
],
"spec.tls_tcp.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.tls_tcp.tls_cert_params.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.tls_tcp.tls_parameters.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.tls_tcp_auto_cert.mtls_choice": [
"no_mtls",
"use_mtls"
],
"spec.tls_tcp_auto_cert.tls_config.choice": [
"custom_security",
"default_security",
"low_security",
"medium_security"
],
"spec.tls_tcp_auto_cert.use_mtls.crl_choice": [
"crl",
"no_crl"
],
"spec.tls_tcp_auto_cert.use_mtls.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
],
"spec.tls_tcp_auto_cert.use_mtls.xfcc_header": [
"xfcc_disabled",
"xfcc_options"
]
}
},
{
"name": "list_tcp_loadbalancers",
"description": "List Configure TCP Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/tcp_loadbalancers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_tcp_loadbalancer",
"description": "DELETE Configure TCP Load Balancer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/tcp_loadbalancers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a tcp_loadbalancer",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.tcp_loadbalancer.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tcp_loadbalancerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tcp_loadbalancerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
}
},
{
"name": "get_tcp_loadbalancer",
"description": "GET TCP Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/tcp_loadbalancers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"tenant-configurations": {
"name": "tenant-configurations",
"displayName": "Tenant Configurations",
"operations": [
{
"name": "create_tenant_configuration",
"description": "Create tenant configuration.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/tenant_configurations",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of tenant_configuration",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.tenant_configuration.CreateRequest",
"properties": {
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationCreateSpecType"
}
],
"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 tenant_configurationCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_configurationCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_configurationCreateRequest"
},
"fieldMetadata": {
"spec": {
"type": "object",
"description": "Shape of the tenant configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.brute_force_detection": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.brute_force_detection.max_login_failures": {
"type": "integer",
"description": "How many failures before wait is triggered.\nWhen login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.digits": {
      "type": "integer",
"description": "The number of digits required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.expire_password": {
      "type": "integer",
"description": "The number of days for which the password is valid.\nAfter the number of days has expired, the user is required to change their password.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1080,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.lowercase_characters": {
      "type": "integer",
"description": "The number of lower case letters required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.minimum_length": {
      "type": "integer",
"description": "Minimum length of password.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 7,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.password_policy.not_recently_used": {
      "type": "integer",
"description": "This policy is used to restrict user from using previously used passwords.\nNumber that's set determines number of last passwords which user cannot use as new password.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.not_username": {
      "type": "boolean",
"description": "When set, the password is not allowed to be the same as the username.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.special_characters": {
      "type": "integer",
"description": "The number of special characters like '?!#%$' required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.uppercase_characters": {
      "type": "integer",
"description": "The number of upper case letters required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_details": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_details.display_name": {
"type": "string",
"description": "Changes the tenant name displayed during login without affecting your company’s domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"pattern": "^[^<>&\\\"]+$",
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_session_expiration": {
"type": "object",
"description": "Defines all session-related expiration for user sessions within a tenant's environment.\nRelationship between session_expiry and cookie_expiry:\n- session_expiry defines the 'absolute maximum duration' of a session and enforces RE-authentication after this time.\n- cookie_expiry defines the 'inactivity timeout', which resets on user activity and only logs out users after idle periods.\nTogether, these ensure the user is logged out when either the session reaches its maximum age or the user is inactive for too long.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_session_expiration.absolute_timeout": {
"type": "object",
"description": "Represents the session expiration duration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_session_expiration.idle_timeout": {
"type": "object",
"description": "Represents the cookie expiration duration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.user_session_expiration.absolute_timeout.unit_of_time": [
"hours",
"minutes"
],
"spec.user_session_expiration.idle_timeout.unit_of_time": [
"hours",
"minutes"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tenant_configuration",
"description": "Replace tenant configuration.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/tenant_configurations/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a tenant_configuration",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.tenant_configuration.ReplaceRequest",
"properties": {
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationReplaceSpecType"
}
],
"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 tenant_configurationReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_configurationReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_configurationReplaceRequest"
},
"fieldMetadata": {
"spec": {
"type": "object",
"description": "Shape of the tenant configuration specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.brute_force_detection": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.brute_force_detection.max_login_failures": {
"type": "integer",
"description": "How many failures before wait is triggered.\nWhen login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.digits": {
      "type": "integer",
"description": "The number of digits required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.expire_password": {
      "type": "integer",
"description": "The number of days for which the password is valid.\nAfter the number of days has expired, the user is required to change their password.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1080,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.lowercase_characters": {
      "type": "integer",
"description": "The number of lower case letters required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.minimum_length": {
      "type": "integer",
"description": "Minimum length of password.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 7,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.password_policy.not_recently_used": {
      "type": "integer",
"description": "This policy is used to restrict user from using previously used passwords.\nNumber that's set determines number of last passwords which user cannot use as new password.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.not_username": {
      "type": "boolean",
"description": "When set, the password is not allowed to be the same as the username.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.special_characters": {
      "type": "integer",
"description": "The number of special characters like '?!#%$' required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.password_policy.uppercase_characters": {
      "type": "integer",
"description": "The number of upper case letters required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_details": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tenant_details.display_name": {
"type": "string",
"description": "Changes the tenant name displayed during login without affecting your company’s domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"pattern": "^[^<>&\\\"]+$",
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.user_session_expiration": {
"type": "object",
"description": "Defines all session-related expiration for user sessions within a tenant's environment.\nRelationship between session_expiry and cookie_expiry:\n- session_expiry defines the 'absolute maximum duration' of a session and enforces RE-authentication after this time.\n- cookie_expiry defines the 'inactivity timeout', which resets on user activity and only logs out users after idle periods.\nTogether, these ensure the user is logged out when either the session reaches its maximum age or the user is inactive for too long.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_session_expiration.absolute_timeout": {
"type": "object",
"description": "Represents the session expiration duration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_session_expiration.idle_timeout": {
"type": "object",
"description": "Represents the cookie expiration duration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.user_session_expiration.absolute_timeout.unit_of_time": [
"hours",
"minutes"
],
"spec.user_session_expiration.idle_timeout.unit_of_time": [
"hours",
"minutes"
]
}
},
{
"name": "list_tenant_configurations",
"description": "List Tenant Configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/tenant_configurations",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_tenant_configuration",
"description": "DELETE Tenant Configuration.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/tenant_configurations/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a tenant_configuration",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.tenant_configuration.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_configurationDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_configurationDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_tenant_configuration",
"description": "GET tenant configuration.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/tenant_configurations/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"tenant-domain-owner-assign": {
"name": "tenant-domain-owner-assign",
"displayName": "Tenant Domain Owner Assign",
"operations": [
{
"name": "create_tenant_domain_owner_assign",
"description": "Assign domain owner.",
"method": "POST",
"path": "/api/web/namespaces/system/tenant/domain_owner/assign",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Domain owner assignment request.",
"title": "Domain owner assignment request",
"x-displayname": "Domain owner assignment request.",
"x-ves-proto-message": "ves.io.schema.tenant.AssignDomainOwnerRequest",
"properties": {
"email": {
"type": "string",
"description": "Assign domain owner to user with this email.",
"title": "Email",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-description-short": "Assign domain owner to user with this email.",
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+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 tenantAssignDomainOwnerRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantAssignDomainOwnerRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantAssignDomainOwnerRequest"
},
"fieldMetadata": {
"email": {
"type": "string",
"description": "Assign domain owner to user with this email.",
"constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"tenant-domain-owner-unassign": {
"name": "tenant-domain-owner-unassign",
"displayName": "Tenant Domain Owner Unassign",
"operations": [
{
"name": "create_tenant_domain_owner_unassign",
"description": "Unassign domain owner.",
"method": "POST",
"path": "/api/web/namespaces/system/tenant/domain_owner/unassign",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Domain owner assignment request.",
"title": "Domain owner un-assignment request",
"x-displayname": "Domain owner un-assignment request.",
"x-ves-proto-message": "ves.io.schema.tenant.UnassignDomainOwnerRequest",
"properties": {
"email": {
"type": "string",
"description": "Remove domain owner privilege from user with this email.",
"title": "Email",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-description-short": "Remove domain owner privilege from user with this email.",
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+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 tenantUnassignDomainOwnerRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantUnassignDomainOwnerRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantUnassignDomainOwnerRequest"
},
"fieldMetadata": {
"email": {
"type": "string",
"description": "Remove domain owner privilege from user with this email.",
"constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"tenant-idm-events-last-login": {
"name": "tenant-idm-events-last-login",
"displayName": "Tenant Idm Events Last Login",
"operations": [
{
"name": "list_tenant_idm_events_last_login",
"description": "GetLastLoginMap.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/idm/events/last_login",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"last_login_map": {
"type": "object"
}
}
},
"responseSummary": [
{
"field": "last_login_map",
"type": "object",
"description": "Login map username->timestamp."
}
]
}
]
},
	"tenant-idm-events-login": {
"name": "tenant-idm-events-login",
"displayName": "Tenant Idm Events Login",
"operations": [
{
"name": "list_tenant_idm_events_login",
"description": "GetLoginEvents.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/idm/events/login",
      "dangerLevel": "low",
"parameters": [
{
"name": "first",
"in": "query",
"required": false,
"type": "integer"
},
{
"name": "max",
"in": "query",
"required": false,
"type": "integer"
}
],
"responseSchema": {
"type": "object",
"properties": {
"login_events_map": {
"type": "object"
}
}
},
"responseSummary": [
{
"field": "login_events_map",
"type": "object",
"description": "Map of login events based on input filter group by username."
}
]
}
]
},
	"tenant-idm-events-login-in-time": {
"name": "tenant-idm-events-login-in-time",
"displayName": "Tenant Idm Events Login In Time",
"operations": [
{
"name": "create_tenant_idm_events_login_in_time",
"description": "GetLoginEventsInTimeFrame.",
"method": "POST",
"path": "/api/web/namespaces/system/tenant/idm/events/login_in_time",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Contains fields to retrieve events in timeframe.",
"title": "GetLoginEventsInTimeFrameRequest",
"x-displayname": "GetLoginEventsInTimeFrameRequest.",
"x-ves-proto-message": "ves.io.schema.tenant.GetLoginEventsInTimeFrameRequest",
"properties": {
"end": {
"type": "string",
"description": "End time",
"title": "End",
"format": "date-time",
"x-displayname": "End",
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"first": {
"type": "integer",
"description": "Records per page.",
"title": "Max",
"format": "int64",
"x-displayname": "Max",
"x-ves-example": "25",
"x-f5xc-example": "25",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"max": {
"type": "integer",
"description": "Records per page.",
"title": "Max",
"format": "int64",
"x-displayname": "Max",
"x-ves-example": "25",
"x-f5xc-example": "25",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start": {
"type": "string",
"description": "Start time.",
"title": "Start",
"format": "date-time",
"x-displayname": "Start",
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Contains fields to retrieve events in timeframe.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenantGetLoginEventsInTimeFrameRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantGetLoginEventsInTimeFrameRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"login_events_map": {
"type": "object"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantGetLoginEventsInTimeFrameRequest"
},
"fieldMetadata": {
"end": {
"type": "string",
"description": "End time",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"first": {
"type": "integer",
"description": "Records per page.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"max": {
"type": "integer",
"description": "Records per page.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start": {
"type": "string",
"description": "Start time.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "login_events_map",
"type": "object",
"description": "Map of login events based on input filter group by username."
}
]
}
]
},
	"tenant-idm-settings": {
"name": "tenant-idm-settings",
"displayName": "Tenant Idm Settings",
"operations": [
{
"name": "list_tenant_idm_settings",
"description": "GetIDMSettings.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/idm/settings",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "basic_configuration",
"type": "object",
"description": ""
},
{
"field": "brute_force_detection",
"type": "object",
"description": ""
},
{
"field": "brute_force_detection_settings",
"type": "object",
"description": ""
},
{
"field": "password_policy",
      "type": "object",
"description": ""
},
{
"field": "tenant_details",
"type": "object",
"description": ""
},
{
"field": "user_session_expiration",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tenant_idm_setting",
"description": "UpdateIDMSettings.",
"method": "PUT",
"path": "/api/web/namespaces/system/tenant/idm/settings",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Shape of the tenant configuration specification.",
"title": "GlobalSpecType",
"x-displayname": "Global Specification.",
"x-ves-proto-message": "ves.io.schema.views.tenant_configuration.GlobalSpecType",
"properties": {
"basic_configuration": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationBasicConfiguration"
}
],
"x-f5xc-description-short": "Configuration parameter for basic configuration.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"brute_force_detection": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings"
}
],
"x-f5xc-description-short": "Configuration parameter for brute force detection.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"brute_force_detection_settings": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationBruteForceDetectionSettings"
}
],
"x-f5xc-description-short": "Configuration parameter for brute force detection settings.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy": {
      "allOf": [
{
"$ref": "#/components/schemas/tenant_configurationPasswordPolicy"
      }
],
"x-f5xc-description-short": "Policy configuration for this feature.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tenant_details": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationBasicConfiguration"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration": {
"allOf": [
{
"$ref": "#/components/schemas/tenant_configurationUserSessionExpiration"
}
],
"x-f5xc-description-short": "Configuration parameter for user session expiration.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Shape of the tenant configuration specification.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for viewstenant_configurationGlobalSpecType",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for viewstenant_configurationGlobalSpecType\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for viewstenant_configurationGlobalSpecType"
},
"fieldMetadata": {
"basic_configuration": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"basic_configuration.display_name": {
"type": "string",
"description": "Changes the tenant name displayed during login without affecting your company’s domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"pattern": "^[^<>&\\\"]+$",
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"brute_force_detection": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"brute_force_detection.max_login_failures": {
"type": "integer",
"description": "How many failures before wait is triggered.\nWhen login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"brute_force_detection_settings": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"brute_force_detection_settings.max_login_failures": {
"type": "integer",
"description": "How many failures before wait is triggered.\nWhen login failure count is hit, user will be temporarily locked for a max duration of 15 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.digits": {
      "type": "integer",
"description": "The number of digits required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.expire_password": {
      "type": "integer",
"description": "The number of days for which the password is valid.\nAfter the number of days has expired, the user is required to change their password.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 1080,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.lowercase_characters": {
      "type": "integer",
"description": "The number of lower case letters required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.minimum_length": {
      "type": "integer",
"description": "Minimum length of password.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 7,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"password_policy.not_recently_used": {
      "type": "integer",
"description": "This policy is used to restrict user from using previously used passwords.\nNumber that's set determines number of last passwords which user cannot use as new password.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.not_username": {
      "type": "boolean",
"description": "When set, the password is not allowed to be the same as the username.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.special_characters": {
      "type": "integer",
"description": "The number of special characters like '?!#%$' required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"password_policy.uppercase_characters": {
      "type": "integer",
"description": "The number of upper case letters required to be in the password string.",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 16,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tenant_details": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"tenant_details.display_name": {
"type": "string",
"description": "Changes the tenant name displayed during login without affecting your company’s domain name.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 255,
"minLength": 1,
"characterSet": {
"description": "Free text with UTF-8 support"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"pattern": "^[^<>&\\\"]+$",
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"user_session_expiration": {
"type": "object",
"description": "Defines all session-related expiration for user sessions within a tenant's environment.\nRelationship between session_expiry and cookie_expiry:\n- session_expiry defines the 'absolute maximum duration' of a session and enforces RE-authentication after this time.\n- cookie_expiry defines the 'inactivity timeout', which resets on user activity and only logs out users after idle periods.\nTogether, these ensure the user is logged out when either the session reaches its maximum age or the user is inactive for too long.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration.absolute_timeout": {
"type": "object",
"description": "Represents the session expiration duration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration.absolute_timeout.hours": {
"type": "object",
"description": "Represents the session duration in hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration.absolute_timeout.minutes": {
"type": "object",
"description": "Represents the session duration in minutes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration.idle_timeout": {
"type": "object",
"description": "Represents the cookie expiration duration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration.idle_timeout.hours": {
"type": "object",
"description": "Represents the cookie duration in hours.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_session_expiration.idle_timeout.minutes": {
"type": "object",
"description": "Represents the cookie duration in minutes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"user_session_expiration.absolute_timeout.unit_of_time": [
"hours",
"minutes"
],
"user_session_expiration.idle_timeout.unit_of_time": [
"hours",
"minutes"
]
}
}
]
},
	"tenant-idm-users-inactive": {
"name": "tenant-idm-users-inactive",
"displayName": "Tenant Idm Users Inactive",
"operations": [
{
"name": "list_tenant_idm_users_inactive",
"description": "ListInactiveUsers.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/idm/users/inactive",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"users": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "users",
"type": "array",
"description": "Collection of users."
}
]
}
]
},
	"tenant-lookup": {
"name": "tenant-lookup",
"displayName": "Tenant Lookup",
"operations": [
{
"name": "list_tenant_lookup",
"description": "Lookup cname.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/lookup",
      "dangerLevel": "low",
"parameters": [
{
"name": "cname",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "namespace",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object"
}
}
]
},
	"tenant-management-delegated-access-subscribe": {
"name": "tenant-management-delegated-access-subscribe",
      "displayName": "Tenant Management Delegated Access Subscribe",
      "operations": [
{
"name": "create_tenant_management_delegated_access_subscribe",
      "description": "Subscribe Delegated Access Addon Service.",
      "method": "POST",
"path": "/api/web/namespaces/system/tenant_management/delegated_access/subscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to subscribe to Tenant Management Service.",
"title": "SubscribeRequest",
"x-displayname": "Subscribe Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.SubscribeRequest",
"x-f5xc-description-short": "Request to subscribe to Tenant Management Service.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementSubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementSubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementSubscribeRequest"
}
}
]
},
	"tenant-management-delegated-access-unsubscribe": {
"name": "tenant-management-delegated-access-unsubscribe",
      "displayName": "Tenant Management Delegated Access Unsubscribe",
      "operations": [
{
"name": "create_tenant_management_delegated_access_unsubscribe",
      "description": "Unsubscribe Delegated Access Addon Service.",
      "method": "POST",
"path": "/api/web/namespaces/system/tenant_management/delegated_access/unsubscribe",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to unsubscribe to Tenant Management Service.",
"title": "UnsubscribeRequest",
"x-displayname": "Unsubscribe Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.UnsubscribeRequest",
"x-f5xc-description-short": "Request to unsubscribe to Tenant Management Service.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_managementUnsubscribeRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_managementUnsubscribeRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_managementUnsubscribeRequest"
}
}
]
},
	"tenant-profiles": {
"name": "tenant-profiles",
"displayName": "Tenant Profiles",
"operations": [
{
"name": "create_tenant_profile",
"description": "Create Tenant Profile.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/tenant_profiles",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of tenant_profile",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.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/tenant_profileCreateSpecType"
}
],
"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 tenant_profileCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_profileCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_profileCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a tenant_profile config instance. Name of the object is the name of the tenant profile to be created.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ct_groups": {
"type": "array",
"description": "List of user groups to be created on child tenant.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_support_access": {
      "type": "boolean",
"description": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant\nfor troubleshooting. Unselecting will pause access for XC Support.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon": {
"type": "object",
"description": "Contains file data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon.aws_s3": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon.content": {
"type": "string",
"description": "Content of the file.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon.content_type": {
"type": "string",
"description": "Content type of the file (MIME type)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo": {
"type": "object",
"description": "Contains file data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo.aws_s3": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo.content": {
"type": "string",
"description": "Content of the file.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo.content_type": {
"type": "string",
"description": "Content type of the file (MIME type)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.plan": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.plan.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.plan.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.plan.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.support_email": {
"type": "string",
"description": "Support Email address for child tenant.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "email",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.favicon.storage_provider": [
"aws_s3"
],
"spec.logo.storage_provider": [
"aws_s3"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tenant_profile",
"description": "Replace Tenant Profile.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/tenant_profiles/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a tenant_profile",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.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/tenant_profileReplaceSpecType"
}
],
"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 tenant_profileReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_profileReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenant_profileReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a tenant_profile configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ct_groups": {
"type": "array",
"description": "List of user groups to be created on child tenant.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_support_access": {
      "type": "boolean",
"description": "Selecting Support Access will allow for F5XC Support teams to access the new Child Tenant\nfor troubleshooting. Unselecting will pause access for XC Support.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon": {
"type": "object",
"description": "Contains file data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon.aws_s3": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon.content": {
"type": "string",
"description": "Content of the file.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.favicon.content_type": {
"type": "string",
"description": "Content type of the file (MIME type)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo": {
"type": "object",
"description": "Contains file data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo.aws_s3": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo.content": {
"type": "string",
"description": "Content of the file.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logo.content_type": {
"type": "string",
"description": "Content type of the file (MIME type)",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.plan": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.plan.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.plan.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.plan.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.support_email": {
"type": "string",
"description": "Support Email address for child tenant.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "email",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.favicon.storage_provider": [
"aws_s3"
],
"spec.logo.storage_provider": [
"aws_s3"
]
}
},
{
"name": "list_tenant_profiles",
"description": "List Tenant Profile.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/tenant_profiles",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_tenant_profile",
"description": "DELETE Tenant Profile.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/tenant_profiles/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a tenant_profile",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.tenant_management.tenant_profile.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenant_profileDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenant_profileDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_tenant_profile",
"description": "GET Tenant Profile.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/tenant_profiles/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"tenant-request-delete": {
"name": "tenant-request-delete",
"displayName": "Tenant Request Delete",
"operations": [
{
"name": "create_tenant_request_delete",
"description": "DELETE Tenant.",
"method": "POST",
"path": "/api/web/namespaces/system/tenant/request-delete",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request for marking Tenant for deletion.",
"title": "DeleteTenantRequest",
"x-displayname": "DeleteTenantRequest.",
"x-ves-proto-message": "ves.io.schema.tenant.DeleteTenantRequest",
"properties": {
"email": {
"type": "string",
"description": "Email of freemium account which need to be deleted.",
"title": "Email",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-description-short": "Email of freemium account which need to be deleted.",
"format": "email",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"feedback": {
"type": "string",
"description": "Feedback from the customer related to reason of account deletion.",
"title": "Feedback",
"x-displayname": "Feedback",
"x-ves-example": "Customers feedback.",
"x-f5xc-example": "Customers feedback",
"x-f5xc-description-short": "Feedback from the customer related to reason of account deletion.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Tenant name marked for deletion.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Tenant-1",
"x-f5xc-example": "tenant-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"reason": {
"allOf": [
{
"$ref": "#/components/schemas/tenantDeletionReason"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request for marking Tenant for deletion.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenantDeleteTenantRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantDeleteTenantRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantDeleteTenantRequest"
},
"fieldMetadata": {
"email": {
"type": "string",
"description": "Email of freemium account which need to be deleted.",
"constraints": {
"constraintType": "string",
"category": "communication",
"maxLength": 1024,
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"format": "email",
"minLength": 3,
"formatDescription": "RFC 5322 email address, max 254 characters",
"validation": {
"rfc": "RFC 5322"
},
"metadata": {
"source": "inferred",
"confidence": 0.95,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"feedback": {
"type": "string",
"description": "Feedback from the customer related to reason of account deletion.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Tenant name marked for deletion.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"reason": {
"type": "string",
"description": "List of available reason for account deletion.\n\n- REASON_UNKNOWN: Unknown reason\n\nUnknown reason\n- REASON_SWITCH_TO_FREE_PLAN: Switch to free plan\n\nSwitch to free plan\n- REASON_NO_LONGER_NEEDED: No longer needed\n\nNo longer needed\n- REASON_NOT_JUSTIFY_COSTS: Too expensive\n\nToo expensive\n- REASON_DIFFICULT_TO_USE: Difficult to use\n\nDifficult to use.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "REASON_UNKNOWN"
}
}
}
]
},
	"tenant-settings": {
"name": "tenant-settings",
"displayName": "Tenant Settings",
"operations": [
{
"name": "list_tenant_settings",
"description": "Tenant Settings.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/settings",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"active_plan_transition_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"domain": {
"type": "string"
},
"name": {
"type": "string"
},
"original_tenant": {
"type": "string"
},
"otp_enabled": {
"type": "boolean"
},
"scim_enabled": {
"type": "boolean"
},
"sso_enabled": {
"type": "boolean"
}
}
},
"responseSummary": [
{
"field": "active_plan_transition_id",
"type": "string",
"description": "ID of the plan transition request which is currently in state CREATING."
},
{
"field": "company_name",
"type": "string",
"description": "Company name of the tenant."
},
{
"field": "domain",
"type": "string",
"description": "Domain of the tenant."
},
{
"field": "max_credentials_expiry",
      "type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "Name will represent name of the tenant that is being accessed."
      },
{
"field": "original_tenant",
"type": "string",
"description": "Orginal_tenant represent tenant ID where the user belongs to."
},
{
"field": "otp_enabled",
"type": "boolean",
"description": "OTP configuration for tenant scope."
},
{
"field": "otp_status",
"type": "object",
"description": ""
},
{
"field": "scim_enabled",
"type": "boolean",
"description": "Flag to show SCIM is enabled for specific tenant."
},
{
"field": "sso_enabled",
"type": "boolean",
"description": "Flag to show SSO is enabled for specific tenant."
},
{
"field": "state",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tenant_setting",
"description": "Tenant Settings.",
"method": "PUT",
"path": "/api/web/namespaces/system/tenant/settings",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request to update tenant settings for specific tenant.",
"title": "UpdateTenantSettingsRequest",
"x-displayname": "UpdateTenantSettingsRequest.",
"x-ves-proto-message": "ves.io.schema.tenant.UpdateTenantSettingsRequest",
"properties": {
"max_credentials_expiry": {
      "allOf": [
{
"$ref": "#/components/schemas/tenantCredentialsExpiry"
      }
],
"x-f5xc-description-short": "Configuration parameter for max credentials expiry.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"otp_enabled": {
"type": "boolean",
"description": "OTP configuration for tenant scope.",
"title": "OTP Enabled",
"format": "boolean",
"x-displayname": "OTP Enabled.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to update tenant settings for specific tenant.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenantUpdateTenantSettingsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantUpdateTenantSettingsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"otp_enabled": {
"type": "boolean"
},
"scim_enabled": {
"type": "boolean"
},
"sso_enabled": {
"type": "boolean"
},
"validation_errors": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantUpdateTenantSettingsRequest"
},
"fieldMetadata": {
"max_credentials_expiry": {
      "type": "object",
"description": "CredentialsExpiry is a struct that holds max expiration days setting for the different credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"max_credentials_expiry.max_api_certificate_expiry_days": {
      "type": "integer",
"description": "Certificate expiry period as days.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"max_credentials_expiry.max_api_token_expiry_days": {
      "type": "integer",
"description": "Token expiry period as days.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"max_credentials_expiry.max_kube_config_expiry_days": {
      "type": "integer",
"description": "TokeKubeconfign expiry period as days.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"otp_enabled": {
"type": "boolean",
"description": "OTP configuration for tenant scope.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "max_credentials_expiry",
      "type": "object",
"description": ""
},
{
"field": "otp_enabled",
"type": "boolean",
"description": "OTP configuration for tenant scope."
},
{
"field": "otp_status",
"type": "object",
"description": ""
},
{
"field": "scim_enabled",
"type": "boolean",
"description": "Flag to show SCIM is enabled for specific tenant."
},
{
"field": "sso_enabled",
"type": "boolean",
"description": "Flag to show SSO is enabled for specific tenant."
},
{
"field": "validation_errors",
"type": "array",
"description": "X-displayName : \"Validation errors\"\ncollection of validation errors."
}
]
}
]
},
	"tenant-settings-otp-disable": {
"name": "tenant-settings-otp-disable",
"displayName": "Tenant Settings Otp Disable",
"operations": [
{
"name": "replace_tenant_settings_otp_disable",
"description": "Disable tenant level OTP.",
"method": "PUT",
"path": "/api/web/namespaces/system/tenant/settings/otp/disable",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"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.tenant.Empty",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schematenantEmpty",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schematenantEmpty\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schematenantEmpty"
}
}
]
},
	"tenant-settings-otp-enable": {
"name": "tenant-settings-otp-enable",
"displayName": "Tenant Settings Otp Enable",
"operations": [
{
"name": "replace_tenant_settings_otp_enable",
"description": "Enable tenant level OTP.",
"method": "PUT",
"path": "/api/web/namespaces/system/tenant/settings/otp/enable",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"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.tenant.Empty",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for schematenantEmpty",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for schematenantEmpty\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for schematenantEmpty"
}
}
]
},
	"tenant-settings-tenant-favicon": {
"name": "tenant-settings-tenant-favicon",
"displayName": "Tenant Settings Tenant Favicon",
"operations": [
{
"name": "list_tenant_settings_tenant_favicon",
"description": "Tenant favicon.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/settings/tenant/favicon",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"tenant-settings-tenant-image": {
"name": "tenant-settings-tenant-image",
"displayName": "Tenant Settings Tenant Image",
"operations": [
{
"name": "delete_tenant_settings_tenant_image",
"description": "DELETE tenant profile image.",
"method": "DELETE",
"path": "/api/web/namespaces/system/tenant/settings/tenant/image",
      "dangerLevel": "high",
"parameters": [],
"responseSchema": {
"type": "object"
}
},
{
"name": "list_tenant_settings_tenant_image",
"description": "Tenant profile image.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/settings/tenant/image",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
},
{
"name": "replace_tenant_settings_tenant_image",
"description": "Update tenant profile image.",
"method": "PUT",
"path": "/api/web/namespaces/system/tenant/settings/tenant/image",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Update user image request.",
"title": "Update user image request",
"x-displayname": "Update user image request.",
"x-ves-proto-message": "ves.io.schema.tenant.UpdateImageRequest",
"properties": {
"content_type": {
"type": "string",
"description": "Type of uploading image.",
"x-displayname": "ContentType.",
"x-ves-example": "Image/jpeg.",
"x-f5xc-example": "image/jpeg",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"image": {
"type": "string",
"description": "Blob of the tenant profile image.",
"format": "byte",
"x-displayname": "Image",
"x-ves-example": "DXNlci1pbWFnZS5qcGVn.",
"x-f5xc-example": "dXNlci1pbWFnZS5qcGVn",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tenantUpdateImageRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tenantUpdateImageRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tenantUpdateImageRequest"
},
"fieldMetadata": {
"content_type": {
"type": "string",
"description": "Type of uploading image.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"image": {
"type": "string",
"description": "Blob of the tenant profile image.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"tenant-settings-tenant-logo": {
"name": "tenant-settings-tenant-logo",
"displayName": "Tenant Settings Tenant Logo",
"operations": [
{
"name": "list_tenant_settings_tenant_logo",
"description": "Tenant logo.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/settings/tenant/logo",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"tenant-support-info": {
"name": "tenant-support-info",
"displayName": "Tenant Support Info",
"operations": [
{
"name": "list_tenant_support_info",
"description": "Support Info.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/support-info",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"support_email_address": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "support_email_address",
"type": "string",
"description": "Support Email address for tenant."
}
]
}
]
},
	"tenant-tenant-escalation-doc": {
"name": "tenant-tenant-escalation-doc",
"displayName": "Tenant Tenant Escalation Doc",
"operations": [
{
"name": "list_tenant_tenant_escalation_doc",
"description": "Tenant escalation document.",
"method": "GET",
"path": "/api/web/namespaces/system/tenant/tenant-escalation-doc",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
}
]
},
	"tenants-summary": {
"name": "tenants-summary",
"displayName": "Tenants Summary",
"operations": [
{
"name": "list_tenants_summary",
"description": "Summary",
"method": "GET",
"path": "/api/config/tenants/{tenant}/summary",
      "dangerLevel": "low",
"parameters": [
{
"name": "tenant",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"preferred_lma_region": {
"type": "string"
},
"type": {
"type": "string"
},
"vip": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "preferred_lma_region",
"type": "string",
"description": "Preferred LMA Region."
},
{
"field": "type",
"type": "string",
"description": "Default VIP Type (dedicated/shared)"
},
{
"field": "vip",
"type": "string",
"description": "Default VIP."
}
]
}
]
},
	"terraform-force-delete": {
"name": "terraform-force-delete",
"displayName": "Terraform Force Delete",
"operations": [
{
"name": "create_terraform_force_delete",
"description": "Force DELETE view.",
"method": "POST",
"path": "/api/terraform/namespaces/{namespace}/terraform/{view_kind}/{view_name}/force-delete",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "view_kind",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "view_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Force DELETE view request.",
"title": "ForceDeleteRequest",
"x-displayname": "Force DELETE view request.",
"x-ves-proto-message": "ves.io.schema.views.terraform_parameters.ForceDeleteRequest",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for the label to be retrieved.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for the label to be retrieved.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"view_kind": {
"type": "string",
"description": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
"title": "Kind of View",
"x-displayname": "Kind of View.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"view_name": {
"type": "string",
"description": "Name of the view for which terraform parameters are requested.",
"title": "Name of view",
"x-displayname": "Name of view.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the view for which terraform parameters are requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for terraform_parametersForceDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for terraform_parametersForceDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for terraform_parametersForceDeleteRequest"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "Namespace for the label to be retrieved.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"view_kind": {
"type": "string",
"description": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"view_name": {
"type": "string",
"description": "Name of the view for which terraform parameters are requested.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"terraform-parameters": {
"name": "terraform-parameters",
"displayName": "Terraform Parameters",
"operations": [
{
"name": "get_terraform_parameter",
"description": "GET Terraform Parameters for view.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/terraform_parameters/{view_kind}/{view_name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "view_kind",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "view_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "terraform_parameters",
"type": "object",
"description": ""
}
]
}
]
},
	"terraform-run": {
"name": "terraform-run",
"displayName": "Terraform Run",
"operations": [
{
"name": "create_terraform_run",
"description": "Run Terraform Action for view.",
"method": "POST",
"path": "/api/terraform/namespaces/{namespace}/terraform/{view_kind}/{view_name}/run",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "view_kind",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "view_name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Perform terraform actions for a given view. Supported actions are apply and plan.",
"title": "Run Terraform Action for view",
"x-displayname": "Run Terraform Action for view.",
"x-ves-proto-message": "ves.io.schema.views.terraform_parameters.RunRequest",
"properties": {
"action": {
"allOf": [
{
"$ref": "#/components/schemas/terraform_parametersRunAction"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the label to be retrieved.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Namespace for the label to be retrieved.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"view_kind": {
"type": "string",
"description": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
"title": "Kind of View",
"x-displayname": "Kind of View.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"view_name": {
"type": "string",
"description": "Name of the view for which terraform parameters are requested.",
"title": "Name of view",
"x-displayname": "Name of view.",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the view for which terraform parameters are requested.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Perform terraform actions for a given view. Supported actions are apply and plan.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for terraform_parametersRunRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for terraform_parametersRunRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for terraform_parametersRunRequest"
},
"fieldMetadata": {
"action": {
"type": "string",
"description": "Terraform action to be performed for a given view e.g. Plan, apply\n\nApply action used to apply the changes required to reach the desired state of the configuration\nPlan action is a convenient way to check whether the execution plan for a set of changes matches your expectations without making any changes to real resources or to the state\nDESTROY action is used to destroy the Terraform-managed infrastructure.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "APPLY"
},
"namespace": {
"type": "string",
"description": "Namespace for the label to be retrieved.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"view_kind": {
"type": "string",
"description": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"view_name": {
"type": "string",
"description": "Name of the view for which terraform parameters are requested.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"test": {
"name": "test",
"displayName": "Test",
"operations": [
{
"name": "create_test",
"description": "Test Log Receiver.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/log_receivers/{name}/test",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to send test log.",
"title": "Test Log Receiver Request",
"x-displayname": "Test Log Receiver Request.",
"x-ves-proto-message": "ves.io.schema.log_receiver.TestLogReceiverRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the log receiver.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Slack1",
"x-f5xc-example": "slack1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace in which the log receiver is configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Namespace in which the log receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for log_receiverTestLogReceiverRequest",
"required_fields": [
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for log_receiverTestLogReceiverRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"namespace": "value"
}
},
"requiredFields": [
"namespace"
],
"description": "Minimum configuration for log_receiverTestLogReceiverRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the log receiver.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace in which the log receiver is configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"third-party-applications": {
"name": "third-party-applications",
"displayName": "Third Party Applications",
"operations": [
{
"name": "replace_third_party_application",
"description": "Replace Third Party Applicationr.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/third_party_applications/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a third_party_application",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.third_party_application.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/viewsthird_party_applicationReplaceSpecType"
}
],
"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 third_party_applicationReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for third_party_applicationReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for third_party_applicationReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Third Party Application specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification": {
      "type": "object",
"description": "Settings for API specification (API definition, OpenAPI validation, etc.)",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.api_definition": {
      "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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_all_spec_endpoints": {
      "type": "object",
"description": "Settings for API Inventory validation.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_custom_list": {
      "type": "object",
"description": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.\nAny other API-endpoint not listed will act according to \"Fall Through Mode\".",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.api_specification.validation_disabled": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sensitive_data_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_definition": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_api_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery": {
      "type": "object",
"description": "Specifies the settings used for API discovery.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_crawler": {
      "type": "object",
"description": "API Crawler message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.api_discovery_from_code_scan": {
      "type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.custom_api_auth_discovery": {
      "type": "object",
"description": "API Discovery Advanced settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.default_api_auth_discovery": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.disable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.discovered_api_settings": {
      "type": "object",
"description": "Configure Discovered API Settings.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_api_discovery.enable_learn_from_redirect_traffic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "object",
"description": "Settings for data type policy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy.sensitive_data_policy_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.api_definition_choice": [
      "api_specification",
      "disable_api_definition"
      ],
"spec.api_discovery_choice": [
      "disable_api_discovery",
      "enable_api_discovery"
      ],
"spec.sensitive_data_policy_choice": [
"default_sensitive_data_policy",
"sensitive_data_policy"
],
"spec.api_specification.validation_target_choice": [
      "validation_all_spec_endpoints",
"validation_custom_list",
"validation_disabled"
],
"spec.api_specification.validation_all_spec_endpoints.oversized_body_choice": [],
      "spec.api_specification.validation_custom_list.oversized_body_choice": [],
      "spec.enable_api_discovery.api_discovery_settings_choice": [
      "custom_api_auth_discovery",
      "default_api_auth_discovery"
      ],
"spec.enable_api_discovery.learn_from_redirect_traffic": [
      "disable_learn_from_redirect_traffic",
"enable_learn_from_redirect_traffic"
],
"spec.enable_api_discovery.api_crawler.api_crawler": [
      "api_crawler_config",
      "disable_api_crawler"
      ]
}
},
{
"name": "list_third_party_applications",
"description": "List Third Party Application.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/third_party_applications",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_third_party_application",
"description": "GET Third Party Application.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/third_party_applications/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ticket-tracking-systems": {
"name": "ticket-tracking-systems",
"displayName": "Ticket Tracking Systems",
"operations": [
{
"name": "create_ticket_tracking_system",
"description": "Create Ticket Tracking System.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/ticket_tracking_systems",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of ticket_tracking_system",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.ticket_management.ticket_tracking_system.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/ticket_tracking_systemCreateSpecType"
}
],
"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 ticket_tracking_systemCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ticket_tracking_systemCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ticket_tracking_systemCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create Ticket Tracking System.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jira_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jira_config.adhoc_rest_api": {
      "type": "object",
"description": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/\nThis message represents what is stored in the XC database. To see the API format, refer to the\nJiraAdhocRestApiConfigurationSpec message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.provider_config": [
"jira_config"
],
"spec.jira_config.config": [
"adhoc_rest_api"
      ]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_ticket_tracking_system",
"description": "Replace Ticket Tracking System.",
"method": "PUT",
"path": "/api/web/namespaces/{namespace}/ticket_tracking_systems/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a ticket_tracking_system",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.ticket_management.ticket_tracking_system.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/ticket_tracking_systemReplaceSpecType"
}
],
"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 ticket_tracking_systemReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ticket_tracking_systemReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ticket_tracking_systemReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces attributes of a Ticket Tracking System.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jira_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.jira_config.adhoc_rest_api": {
      "type": "object",
"description": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/\nThis message represents what is stored in the XC database. To see the API format, refer to the\nJiraAdhocRestApiConfigurationSpec message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.provider_config": [
"jira_config"
],
"spec.jira_config.config": [
"adhoc_rest_api"
      ]
}
},
{
"name": "list_ticket_tracking_systems",
"description": "List Ticket Tracking System.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/ticket_tracking_systems",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_ticket_tracking_system",
"description": "DELETE Ticket Tracking System.",
"method": "DELETE",
"path": "/api/web/namespaces/{namespace}/ticket_tracking_systems/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a ticket_tracking_system",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.ticket_management.ticket_tracking_system.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ticket_tracking_systemDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ticket_tracking_systemDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
}
},
{
"name": "get_ticket_tracking_system",
"description": "GET Ticket Tracking System.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/ticket_tracking_systems/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"ticket-tracking-systems-jira-projects-issue-types": {
"name": "ticket-tracking-systems-jira-projects-issue-types",
"displayName": "Ticket Tracking Systems Jira Projects Issue Types",
"operations": [
{
"name": "create_ticket_tracking_systems_jira_projects_issue_type",
"description": "JIRA Projects & Issue Types.",
"method": "POST",
"path": "/api/web/namespaces/shared/ticket_tracking_systems/jira_projects_issue_types",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "JiraProjectsIssueTypesRequest",
"x-displayname": "Jira Projects & Issue Types Request.",
"x-ves-proto-message": "ves.io.schema.ticket_management.ticket_tracking_system.JiraProjectsIssueTypesRequest",
"properties": {
"ticket_tracking_system": {
"type": "string",
"description": "The name (identifier) of the ticket tracking system for the request.",
"title": "ticket_tracking_system",
"x-displayname": "Ticket Tracking System.",
"x-f5xc-description-short": "The name (identifier) of the ticket tracking system for the request.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ticket_tracking_systemJiraProjectsIssueTypesRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ticket_tracking_systemJiraProjectsIssueTypesRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {
"projects": {
"type": "array"
},
"ticket_tracking_system": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ticket_tracking_systemJiraProjectsIssueTypesRequest"
},
"fieldMetadata": {
"ticket_tracking_system": {
"type": "string",
"description": "The name (identifier) of the ticket tracking system for the request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "projects",
"type": "array",
"description": "A list of Jira projects that are available in the specified ticket tracking system."
},
{
"field": "ticket_tracking_system",
"type": "string",
"description": "The name (identifier) of the ticket tracking system for the request."
}
]
}
]
},
	"ticket-tracking-systems-validate-ticket-tracking-system": {
"name": "ticket-tracking-systems-validate-ticket-tracking-system",
"displayName": "Ticket Tracking Systems Validate Ticket Tracking System",
"operations": [
{
"name": "create_ticket_tracking_systems_validate_ticket_tracking_system",
"description": "Validate Ticket Tracking System.",
"method": "POST",
"path": "/api/web/namespaces/shared/ticket_tracking_systems/validate_ticket_tracking_system",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
      "title": "ValidateTicketTrackingSystemRequest",
"x-displayname": "Validate Ticket Tracking System Request.",
"x-ves-oneof-field-provider_config": "[\"jira_config\"]",
"x-ves-proto-message": "ves.io.schema.ticket_management.ticket_tracking_system.ValidateTicketTrackingSystemRequest",
"properties": {
"jira_config": {
"allOf": [
{
"$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
      "x-f5xc-description-medium": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for ticket_tracking_systemValidateTicketTrackingSystemRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for ticket_tracking_systemValidateTicketTrackingSystemRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "support"
},
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for ticket_tracking_systemValidateTicketTrackingSystemRequest"
},
"fieldMetadata": {
"jira_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"jira_config.adhoc_rest_api": {
      "type": "object",
"description": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/\nThis message represents what is stored in the XC database. To see the API format, refer to the\nJiraAdhocRestApiConfigurationSpec message.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"jira_config.adhoc_rest_api.account_email": {
      "type": "string",
"description": "Username (email) for the Atlassian account.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "email",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"jira_config.adhoc_rest_api.api_token": {
      "type": "string",
"description": "API Token (password) specified by the customer in plaintext to be used for Basic Auth.\nThis value is purely used for user input and is not persisted in the database.\nIt will be converted to a blindfolded and encrypted form before saving.\nFor editing/replacing the existing JIRA configuration, and to use the already stored value of\nthe encrypted API Token, this field should be sent as an empty string.\nSince this field is confidential, the GET/List public APIs will return this value as an empty string.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"jira_config.adhoc_rest_api.organization_domain": {
      "type": "string",
"description": "A valid hostname for the Atlassian organization, as defined by RFC 1034.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"provider_config": [
"jira_config"
],
"jira_config.config": [
"adhoc_rest_api"
      ]
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors related to ticket tracking system creation - such as issues with validation of credentials + organization domain."
      }
]
}
]
},
	"top-cloud-connects": {
"name": "top-cloud-connects",
"displayName": "Top Cloud Connects",
"operations": [
{
"name": "create_top_cloud_connect",
"description": "Top Cloud Connect.",
"method": "POST",
"path": "/api/data/namespaces/system/top/cloud_connects",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"title": "Top Cloud Connect Request",
"x-displayname": "Top Cloud Connect Request.",
"x-ves-proto-message": "ves.io.schema.cloud_connect.TopCloudConnectRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
"x-f5xc-description-medium": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Metric fields to be returned in the response. If no metric fields are specified in the request,\nthen the response will not contain any metric data.",
"title": "Metric Selector",
"items": {
"$ref": "#/components/schemas/cloud_connectFieldSelector"
},
"x-displayname": "Metric Selector.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Metric fields to be returned in the response. If no metric fields are specified in the request, then the response will not contain any metric data.",
"x-f5xc-description-medium": "Metric fields to be returned in the response. If no metric fields are specified in the request, then the response will not contain any metric data.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{CUSTOMER_EDGE=\\\"site-1\\\"}",
"x-f5xc-example": "\"{CUSTOMER_EDGE=\\\"site-1\\\"}\"",
"x-f5xc-description-short": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\"...",
"x-f5xc-description-medium": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results\nDefault 20000.",
"title": "Limit",
"format": "int64",
"x-displayname": "Limit",
"x-ves-example": "5",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "100"
},
"x-f5xc-example": "5",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "100"
},
"x-f5xc-description-short": "Limits the number of results Default 20000.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 100,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If...",
"x-f5xc-description-medium": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for cloud_connectTopCloudConnectRequest",
"required_fields": [
"limit"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for cloud_connectTopCloudConnectRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  limit: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"limit\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "cloud_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"limit": "value"
}
},
"requiredFields": [
"limit"
],
"description": "Minimum configuration for cloud_connectTopCloudConnectRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Metric fields to be returned in the response. If no metric fields are specified in the request,\nthen the response will not contain any metric data.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in Label can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\n\nOptional: If not specified, counter will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of results\nDefault 20000.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 100,
"multipleOf": 1,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of flow collection\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "CloudConnectData wraps the response for the top cloud connect request."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"topology-dc-cluster-group": {
"name": "topology-dc-cluster-group",
"displayName": "Topology Dc Cluster Group",
"operations": [
{
"name": "create_topology_dc_cluster_group",
"description": "DC Cluster Topology.",
"method": "POST",
"path": "/api/data/namespaces/system/topology/dc_cluster_group/{dc_cluster_group}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "dc_cluster_group",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET DC Cluster group topology and the associated metrics.",
"title": "DC Cluster Group Topology Request",
"x-displayname": "DC Cluster Group Topology Request.",
"x-ves-proto-message": "ves.io.schema.topology.DCClusterTopologyRequest",
"properties": {
"dc_cluster_group": {
"type": "string",
"description": "Name of the DC Cluster group.",
"title": "DC Cluster group",
"x-displayname": "DC Cluster group.",
"x-ves-example": "Dcg-1",
"x-f5xc-example": "dcg-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"allOf": [
{
"$ref": "#/components/schemas/topologyMetricSelector"
}
],
"x-f5xc-description-short": "Configuration parameter for metric selector.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET DC Cluster group topology and the associated metrics.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for topologyDCClusterTopologyRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for topologyDCClusterTopologyRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for topologyDCClusterTopologyRequest"
},
"fieldMetadata": {
"dc_cluster_group": {
"type": "string",
"description": "Name of the DC Cluster group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "object",
"description": "MetricSelector is used to specify the list of metrics to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.edge": {
"type": "array",
"description": "List of metrics to be returned for the edges.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.end_time": {
"type": "string",
"description": "End time of metric data. This field is applicable only if \"include_metrics\" is set to true.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.node": {
"type": "array",
"description": "List of metrics to be returned for the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.start_time": {
"type": "string",
"description": "Start time of metric data. This field is applicable only if \"include_metrics\" is set to true.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "List of edges in the topology graph."
},
{
"field": "nodes",
"type": "array",
"description": "List of nodes in the topology graph."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"topology-dc-cluster-groups": {
"name": "topology-dc-cluster-groups",
"displayName": "Topology Dc Cluster Groups",
"operations": [
{
"name": "list_topology_dc_cluster_groups",
"description": "DC Cluster Groups Summary.",
"method": "GET",
"path": "/api/data/namespaces/system/topology/dc_cluster_groups",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "List of edges in the topology graph."
},
{
"field": "nodes",
"type": "array",
"description": "List of nodes in the topology graph."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"topology-network-route-tables": {
"name": "topology-network-route-tables",
"displayName": "Topology Network Route Tables",
"operations": [
{
"name": "list_topology_network_route_tables",
"description": "GET Network Route Tables.",
"method": "GET",
"path": "/api/data/namespaces/system/topology/network/{id}/route_tables",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "route_table_ids",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "subnet_ids",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "subnet_cidrs",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "regions",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "site",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"routes_data": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "routes_data",
"type": "array",
"description": "Network Routes Data."
}
]
}
]
},
	"topology-route-table": {
"name": "topology-route-table",
"displayName": "Topology Route Table",
"operations": [
{
"name": "get_topology_route_table",
"description": "GET Route Table.",
"method": "GET",
"path": "/api/data/namespaces/system/topology/route_table/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "route_table",
"type": "object",
"description": ""
}
]
}
]
},
	"topology-site": {
"name": "topology-site",
"displayName": "Topology Site",
"operations": [
{
"name": "create_topology_site",
"description": "Site Topology.",
"method": "POST",
"path": "/api/data/namespaces/system/topology/site/{site}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET site topology and the associated metrics.",
"title": "Site Topology Request",
"x-displayname": "Site Topology Request.",
"x-ves-proto-message": "ves.io.schema.topology.SiteTopologyRequest",
"properties": {
"group_dc_cluster_nodes": {
"type": "boolean",
"description": "Option to enable or disable grouping of sites in a DC Cluster group.\nIf enabled, then all the sites in a DC Cluster group are returned as a single node in the response.",
"title": "Group DC Cluster nodes",
"format": "boolean",
"x-displayname": "Group DC Cluster nodes.",
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "Option to enable or disable grouping of sites in a DC Cluster group.",
"x-f5xc-description-medium": "Option to enable or disable grouping of sites in a DC Cluster group. If enabled, then all the sites in a DC Cluster group are returned as a single node in the response.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_site_mesh_nodes": {
"type": "boolean",
"description": "Option to enable or disable grouping of sites in a site mesh group.\nIf enabled, then all the sites in a site mesh group are returned as a single node in the response.",
"title": "Group Site Mesh nodes",
"format": "boolean",
"x-displayname": "Group Site Mesh nodes.",
"x-f5xc-description-short": "Option to enable or disable grouping of sites in a site mesh group.",
"x-f5xc-description-medium": "Option to enable or disable grouping of sites in a site mesh group. If enabled, then all the sites in a site mesh group are returned as a single node in the response.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"level": {
"type": "integer",
"description": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node.\nIf the level specified in the request is 1, then the response contains the root node (level:0) and all its immediate neighbors (level:1).\nIf the level is set to -1, then all the nodes and edges in the topology graph will be returned in the response.",
"title": "Level",
"format": "int32",
"x-displayname": "Level",
"x-ves-example": "2",
"x-f5xc-example": "2",
"x-f5xc-description-short": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node.",
"x-f5xc-description-medium": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node. If the level specified in the request is 1, then the response contains the root node (level:0) and all its immediate neighbors (level:1). If the level is set to -1...",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"allOf": [
{
"$ref": "#/components/schemas/topologyMetricSelector"
}
],
"x-f5xc-description-short": "Configuration parameter for metric selector.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node_id": {
"type": "string",
"description": "Specifies the node in the topology graph to start the graph traversal.",
"title": "Node Id",
"x-displayname": "Node ID",
"x-ves-example": "Site:site-1.",
"x-f5xc-example": "site:site-1",
"x-f5xc-description-short": "Specifies the node in the topology graph to start the graph traversal.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"site": {
"type": "string",
"description": "Name of the site.",
"title": "Site",
"x-displayname": "Site",
"x-ves-example": "Ce01",
"x-f5xc-example": "ce01",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET site topology and the associated metrics.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for topologySiteTopologyRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for topologySiteTopologyRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for topologySiteTopologyRequest"
},
"fieldMetadata": {
"group_dc_cluster_nodes": {
"type": "boolean",
"description": "Option to enable or disable grouping of sites in a DC Cluster group.\nIf enabled, then all the sites in a DC Cluster group are returned as a single node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_site_mesh_nodes": {
"type": "boolean",
"description": "Option to enable or disable grouping of sites in a site mesh group.\nIf enabled, then all the sites in a site mesh group are returned as a single node in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"level": {
"type": "integer",
"description": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node.\nIf the level specified in the request is 1, then the response contains the root node (level:0) and all its immediate neighbors (level:1).\nIf the level is set to -1, then all the nodes and edges in the topology graph will be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector": {
"type": "object",
"description": "MetricSelector is used to specify the list of metrics to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.edge": {
"type": "array",
"description": "List of metrics to be returned for the edges.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.end_time": {
"type": "string",
"description": "End time of metric data. This field is applicable only if \"include_metrics\" is set to true.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.node": {
"type": "array",
"description": "List of metrics to be returned for the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.start_time": {
"type": "string",
"description": "Start time of metric data. This field is applicable only if \"include_metrics\" is set to true.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"node_id": {
"type": "string",
"description": "Specifies the node in the topology graph to start the graph traversal.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site": {
"type": "string",
"description": "Name of the site.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "List of edges in the topology graph."
},
{
"field": "nodes",
"type": "array",
"description": "List of nodes in the topology graph."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"topology-site-mesh-group": {
"name": "topology-site-mesh-group",
"displayName": "Topology Site Mesh Group",
"operations": [
{
"name": "create_topology_site_mesh_group",
"description": "Site Mesh Topology.",
"method": "POST",
"path": "/api/data/namespaces/system/topology/site_mesh_group/{site_mesh_group}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "site_mesh_group",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET site mesh group topology and the associated metrics.",
"title": "Site Mesh Group Topology Request",
"x-displayname": "Site Mesh Group Topology Request.",
"x-ves-proto-message": "ves.io.schema.topology.SiteMeshTopologyRequest",
"properties": {
"metric_selector": {
"allOf": [
{
"$ref": "#/components/schemas/topologyMetricSelector"
}
],
"x-f5xc-description-short": "Configuration parameter for metric selector.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site_mesh_group": {
"type": "string",
"description": "Name of the site mesh group.",
"title": "Site Mesh Group",
"x-displayname": "Site Mesh Group.",
"x-ves-example": "Smg-1",
"x-f5xc-example": "smg-1",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET site mesh group topology and the associated metrics.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for topologySiteMeshTopologyRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for topologySiteMeshTopologyRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for topologySiteMeshTopologyRequest"
},
"fieldMetadata": {
"metric_selector": {
"type": "object",
"description": "MetricSelector is used to specify the list of metrics to be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.edge": {
"type": "array",
"description": "List of metrics to be returned for the edges.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.end_time": {
"type": "string",
"description": "End time of metric data. This field is applicable only if \"include_metrics\" is set to true.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.node": {
"type": "array",
"description": "List of metrics to be returned for the nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.start_time": {
"type": "string",
"description": "Start time of metric data. This field is applicable only if \"include_metrics\" is set to true.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metric_selector.step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"site_mesh_group": {
"type": "string",
"description": "Name of the site mesh group.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "List of edges in the topology graph."
},
{
"field": "nodes",
"type": "array",
"description": "List of nodes in the topology graph."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"topology-site-mesh-groups": {
"name": "topology-site-mesh-groups",
"displayName": "Topology Site Mesh Groups",
"operations": [
{
"name": "list_topology_site_mesh_groups",
"description": "Site Mesh Groups Summary.",
"method": "GET",
"path": "/api/data/namespaces/system/topology/site_mesh_groups",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"edges": {
"type": "array"
},
"nodes": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "edges",
"type": "array",
"description": "List of edges in the topology graph."
},
{
"field": "nodes",
"type": "array",
"description": "List of nodes in the topology graph."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"topology-site-networks": {
"name": "topology-site-networks",
"displayName": "Topology Site Networks",
"operations": [
{
"name": "list_topology_site_networks",
"description": "GET Site Networks.",
"method": "GET",
"path": "/api/data/namespaces/system/topology/site/{name}/networks",
      "dangerLevel": "low",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"routes_metadata": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "aws",
"type": "object",
"description": ""
},
{
"field": "routes_metadata",
"type": "array",
"description": "Network Routes Meta Data."
}
]
}
]
},
	"topology-tgw-route-tables": {
"name": "topology-tgw-route-tables",
"displayName": "Topology Tgw Route Tables",
"operations": [
{
"name": "list_topology_tgw_route_tables",
"description": "GET TGW Route Tables.",
"method": "GET",
"path": "/api/data/namespaces/system/topology/tgw/{id}/route_tables",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "route_table_ids",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "attachment_ids",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "site",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"routes_data": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "routes_data",
"type": "array",
"description": "TGW Routes Data."
}
]
}
]
},
	"tpm": {
"name": "tpm",
"displayName": "Tpm",
"operations": [
{
"name": "create_tpm",
"description": "Create TPM API Key.",
      "method": "POST",
"path": "/api/tpm/namespaces/{namespace}/tpm_api_keys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of tpm_api_key",
      "x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tpm_api_key.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/tpm_api_keyCreateSpecType"
      }
],
"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 tpm_api_keyCreateRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tpm_api_keyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tpm_api_keyCreateRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "APIKey object when successfully created returns actual APIKey bytes which is used by the users to call in to\nTPM provisioning API.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.category_ref": {
"type": "array",
"description": "APIKey needs a reference to an existing TPM category object\nTPM category is used for grouping customer owned APIKeys and manage them as one entity.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.need_mtls": {
"type": "boolean",
"description": "Is mTLS required when using this APIKey?",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tpm",
"description": "Replace TPM API Key.",
      "method": "PUT",
"path": "/api/tpm/namespaces/{namespace}/tpm_api_keys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a tpm_api_key",
      "x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tpm_api_key.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/tpm_api_keyReplaceSpecType"
      }
],
"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 tpm_api_keyReplaceRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tpm_api_keyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tpm_api_keyReplaceRequest"
      },
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a APIKey object's revocation or enable/disable status. A revoked APIKey is not considered disabled.\nCertificates minted using disabled APIKeys are rejected during system bring-up/verification stage,\nwhereas certificates minted using revoked APIKeys are only rejected if they were minted after revocation date.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.is_disabled": {
"type": "boolean",
"description": "If true that indicates that this APIKey is disabled.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.revoke_reason": {
"type": "string",
"description": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.revoked_timestamp": {
"type": "string",
"description": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_tpm",
"description": "List TPM API Key.",
      "method": "GET",
"path": "/api/tpm/namespaces/{namespace}/tpm_api_keys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_tpm",
"description": "GET TPM API Key.",
      "method": "GET",
"path": "/api/tpm/namespaces/{namespace}/tpm_api_keys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"tpm-tpm-preauth": {
"name": "tpm-tpm-preauth",
      "displayName": "Tpm Tpm Preauth",
      "operations": [
{
"name": "create_tpm_tpm_preauth",
      "description": "Preauth",
      "method": "POST",
"path": "/api/tpm/tpm/preauth",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "PreauthRequest defines parameters required for pre-flight auth checks\nbefore using the TPM Provisioning API key.",
      "title": "Preauth TPM Provisioning Request",
      "x-displayname": "Preauthorization Request for TPM Provisioning.",
      "x-ves-proto-message": "ves.io.schema.tpm_provision.PreauthRequest",
      "properties": {
"api_key": {
      "type": "string",
"description": "API Key allocated to TPM Provisioning (manufacturing) user.",
      "title": "TPM Provisioning Client API Key",
      "x-displayname": "TPM Provisioning Client API Key.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "API Key allocated to TPM Provisioning (manufacturing) user.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"characterSet": {
"allowed": "[a-zA-Z0-9_-]",
"description": "Alphanumeric with underscores and hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/tpm_provisionDeviceInfo"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "PreauthRequest defines parameters required for pre-flight auth checks before using the TPM Provisioning API key.",
      "x-f5xc-description-medium": "PreauthRequest defines parameters required for pre-flight auth checks before using the TPM Provisioning API key.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tpm_provisionPreauthRequest",
      "required_fields": [
"api_key"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tpm_provisionPreauthRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  api_key: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"api_key\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"api_key": "value"
      }
},
"requiredFields": [
"api_key"
      ],
"description": "Minimum configuration for tpm_provisionPreauthRequest"
      },
"fieldMetadata": {
"api_key": {
      "type": "string",
"description": "API Key allocated to TPM Provisioning (manufacturing) user.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"characterSet": {
"allowed": "[a-zA-Z0-9_-]",
"description": "Alphanumeric with underscores and hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device": {
"type": "object",
"description": "DeviceInfo defines device parameters like Serial-Number to include\nin the TPM provisioning data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"device.name": {
"type": "string",
"description": "Device Name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device.serial": {
"type": "string",
"description": "Serial Number.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device.vendor": {
"type": "string",
"description": "Device Vendor.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device.version": {
"type": "string",
"description": "Device Version.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "status",
"type": "object",
"description": ""
}
]
}
]
},
	"tpm-tpm-provision": {
"name": "tpm-tpm-provision",
"displayName": "Tpm Tpm Provision",
"operations": [
{
"name": "create_tpm_tpm_provision",
"description": "Provision",
"method": "POST",
"path": "/api/tpm/tpm/provision",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "ProvisionReq defines parameters required for TPM Provisioning Request API.",
      "title": "TPM Provisioning Request",
"x-displayname": "Provisioning Request.",
"x-ves-proto-message": "ves.io.schema.tpm_provision.ProvisionRequest",
"properties": {
"ak_pub_key": {
      "type": "string",
"description": "TPM AK Public Key in DER format.",
      "title": "TPM Provisioning AK Public Key",
      "x-displayname": "TPM Attestation Key (AK) Public Key.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"api_key": {
      "type": "string",
"description": "API Key allocated to TPM Provisioning (manufacturing) user.",
      "title": "TPM Provisioning Client API Key",
      "x-displayname": "TPM Provisioning Client API Key.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "API Key allocated to TPM Provisioning (manufacturing) user.",
      "x-f5xc-constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"characterSet": {
"allowed": "[a-zA-Z0-9_-]",
"description": "Alphanumeric with underscores and hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"csr": {
"type": "string",
"description": "Signing request from the manufacturing plant for device TPM provisioning.",
"title": "TPM Provisioning Certificate Signing Request",
"x-displayname": "TPM Provisioning Certificate Signing Request.",
"x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Signing request from the manufacturing plant for device TPM provisioning.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/tpm_provisionDeviceInfo"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"ek_cert": {
"type": "string",
"description": "TPM EK Certificate in DER format.",
"title": "TPM Provisioning Endorsement Key (EK) Certificate",
      "x-displayname": "TPM Endorsement Key (EK) Certificate.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ek_pub_key": {
      "type": "string",
"description": "TPM EK Public Key in DER format.",
      "title": "TPM Provisioning Endorsement Key (EK) Public Key",
      "x-displayname": "TPM Endorsement Key (EK) Public Key.",
      "x-ves-example": "Value",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "value",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "ProvisionReq defines parameters required for TPM Provisioning Request API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tpm_provisionProvisionRequest",
"required_fields": [
"ak_pub_key",
      "api_key",
      "csr",
"ek_cert",
"ek_pub_key"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tpm_provisionProvisionRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  ak_pub_key: value\n  api_key: value\n  csr: value\n  ek_cert: value\n  ek_pub_key: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"ak_pub_key\": \"value\",\n    \"api_key\": \"value\",\n    \"csr\": \"value\",\n    \"ek_cert\": \"value\",\n    \"ek_pub_key\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "bot_and_threat_defense"
},
"responseSchema": {
"type": "object",
"properties": {
"credential_bundle": {
      "type": "string"
},
"encrypted_ak_cert": {
"type": "string"
},
"nonce": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"ak_pub_key": "value",
      "api_key": "value",
      "csr": "value",
"ek_cert": "value",
"ek_pub_key": "value"
      }
},
"requiredFields": [
"ak_pub_key",
      "api_key",
      "csr",
"ek_cert",
"ek_pub_key"
      ],
"description": "Minimum configuration for tpm_provisionProvisionRequest"
},
"fieldMetadata": {
"ak_pub_key": {
      "type": "string",
"description": "TPM AK Public Key in DER format.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"api_key": {
      "type": "string",
"description": "API Key allocated to TPM Provisioning (manufacturing) user.",
      "constraints": {
"constraintType": "string",
"category": "security",
"maxLength": 1024,
"minLength": 20,
"characterSet": {
"allowed": "[a-zA-Z0-9_-]",
"description": "Alphanumeric with underscores and hyphens"
},
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"csr": {
"type": "string",
"description": "Signing request from the manufacturing plant for device TPM provisioning.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device": {
"type": "object",
"description": "DeviceInfo defines device parameters like Serial-Number to include\nin the TPM provisioning data.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"device.name": {
"type": "string",
"description": "Device Name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device.serial": {
"type": "string",
"description": "Serial Number.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device.vendor": {
"type": "string",
"description": "Device Vendor.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"device.version": {
"type": "string",
"description": "Device Version.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ek_cert": {
"type": "string",
"description": "TPM EK Certificate in DER format.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ek_pub_key": {
      "type": "string",
"description": "TPM EK Public Key in DER format.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "credential_bundle",
      "type": "string",
"description": "TPM Credential bundle used to decrypt the encrypted AK certificate."
      },
{
"field": "encrypted_ak_cert",
"type": "string",
"description": "AK Certificate signed by the TPM CA and encrypted according to TPM 2.0 spec."
},
{
"field": "nonce",
"type": "string",
"description": "Nonce used to encrypt the AK certificate."
}
]
}
]
},
	"transit-usage": {
"name": "transit-usage",
"displayName": "Transit Usage",
"operations": [
{
"name": "create_transit_usage",
"description": "Transit Usage.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/infraprotect/transit_usage",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET transit usage data.",
"title": "Transit Usage Request",
"x-displayname": "Transit Usage Request.",
"x-ves-proto-message": "ves.io.schema.infraprotect.TransitUsageRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/infraprotectTransitUsageType"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response.",
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in MetricLabel {POP, DEVICE, INTERFACE} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{POP=\\\"POP-1\\\"}",
"x-f5xc-example": "\"{POP=\\\"pop-1\\\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in MetricLabel {POP, DEVICE, INTERFACE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {POP, DEVICE, INTERFACE}",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/infraprotectTransitUsageLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by zero or more labels {POP, DEVICE, INTERFACE}.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for infraprotectTransitUsageRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for infraprotectTransitUsageRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "ddos"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for infraprotectTransitUsageRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in MetricLabel {POP, DEVICE, INTERFACE} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, metric will be aggregated based on the group_by labels.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {POP, DEVICE, INTERFACE}",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series Transit Usage data."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
}
]
},
	"trust-client-suggestion": {
"name": "trust-client-suggestion",
"displayName": "Trust Client Suggestion",
"operations": [
{
"name": "create_trust_client_suggestion",
"description": "Suggest trust client rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/trust_client/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested blocking SimpleClientSrcRule for a given IP/ASN.",
"title": "GetSuggestedTrustClientRuleReq",
"x-displayname": "GET Suggested Trust Client Rule Request.",
"x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedTrustClientRuleReq",
"properties": {
"as_description": {
"type": "string",
"description": "AS description.",
"title": "Description",
"maxLength": 256,
"x-displayname": "AS Description.",
"x-ves-example": "As-description.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "as-description",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"as_number": {
"type": "integer",
"description": "RFC 6793 defined 4-byte AS number.",
"title": "as number",
"format": "int64",
"x-displayname": "AS Number",
"x-ves-example": "4683",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "401308"
},
"x-f5xc-example": "4683",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.uint32.gte": "0",
"ves.io.schema.rules.uint32.lte": "401308"
},
"x-f5xc-constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 401308,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ip_prefix": {
"type": "string",
"description": "IP prefix string.",
"title": "ip prefix",
"x-displayname": "IP Prefix",
"x-ves-example": "192.0.2.0/24.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.ip_prefix": "true"
},
"x-f5xc-example": "192.0.2.0/24",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.ip_prefix": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "cidr",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ip_reputation": {
"type": "boolean",
"description": "Indicates whether the security event is IP reputation.",
"title": "IP Reputation Security Event",
"format": "boolean",
"x-displayname": "IP Reputation Security Event.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Indicates whether the security event is IP reputation.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this client blocking rule will be applied.",
"title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this client blocking rule will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"sec_event_name": {
"type": "string",
"description": "The name of Security Event.",
"title": "Security Event Name",
"x-displayname": "Security Event Name.",
"x-ves-example": "Malicious User Mitigation.",
"x-f5xc-example": "Malicious User Mitigation",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sec_event_types": {
"type": "array",
"description": "List of Security Event types that should stop being generated for this client.",
"title": "Security Event Types",
"maxItems": 4,
"items": {
"$ref": "#/components/schemas/app_securitySecEventType"
},
"x-displayname": "Security Event Types.",
"x-ves-example": "[WAF_SEC_EVENT]",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "4",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "[WAF_SEC_EVENT]",
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "4",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "List of Security Event types that should stop being generated for this client.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"threat_mesh": {
"type": "boolean",
"description": "Indicates whether the security event is threat mesh.",
"title": "Threat Mesh Security Event",
"format": "boolean",
"x-displayname": "Threat Mesh Security Event.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Indicates whether the security event is threat mesh.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_id": {
"type": "string",
"description": "User ID of trusted client.",
"title": "user id",
"maxLength": 256,
"x-displayname": "User ID",
"x-ves-example": "Abc",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "abc",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
}
},
"x-f5xc-description-short": "GET suggested blocking SimpleClientSrcRule for a given IP/ASN.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedTrustClientRuleReq",
"required_fields": [
"as_number",
"ip_prefix"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedTrustClientRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  as_number: value\n  ip_prefix: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"as_number\": \"value\",\n    \"ip_prefix\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"as_number": "value",
"ip_prefix": "value"
}
},
"requiredFields": [
"as_number",
"ip_prefix"
],
"description": "Minimum configuration for app_securityGetSuggestedTrustClientRuleReq"
},
"fieldMetadata": {
"as_description": {
"type": "string",
"description": "AS description.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"as_number": {
"type": "integer",
"description": "RFC 6793 defined 4-byte AS number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 401308,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ip_prefix": {
"type": "string",
"description": "IP prefix string.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "cidr",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ip_reputation": {
"type": "boolean",
"description": "Indicates whether the security event is IP reputation.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this client blocking rule will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sec_event_name": {
"type": "string",
"description": "The name of Security Event.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sec_event_types": {
"type": "array",
"description": "List of Security Event types that should stop being generated for this client.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"threat_mesh": {
"type": "boolean",
"description": "Indicates whether the security event is threat mesh.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"user_id": {
"type": "string",
"description": "User ID of trusted client.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "HTTP load balancer for which this client rule will be applied."
},
{
"field": "rule",
"type": "object",
"description": ""
}
]
}
]
},
	"trusted-ca-lists": {
"name": "trusted-ca-lists",
"displayName": "Trusted Ca Lists",
"operations": [
{
"name": "create_trusted_ca_list",
"description": "Create Root CA Certificate.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/trusted_ca_lists",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"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_yaml": "# Minimal example for trusted_ca_listCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for trusted_ca_listCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Root CA Certificate specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.trusted_ca_url": {
"type": "string",
"description": "Trusted CA certificates for validating certificates.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512000,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_trusted_ca_list",
"description": "Replace Root CA Certificate.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/trusted_ca_lists/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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_yaml": "# Minimal example for trusted_ca_listReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for trusted_ca_listReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the Root CA Certificate specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.trusted_ca_url": {
"type": "string",
"description": "Trusted CA certificates for validating certificates.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 512000,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_trusted_ca_lists",
"description": "List Root CA Certificate.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/trusted_ca_lists",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_trusted_ca_list",
"description": "DELETE Root CA Certificate.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/trusted_ca_lists/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for trusted_ca_listDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for trusted_ca_listDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
}
},
{
"name": "get_trusted_ca_list",
"description": "GET Root CA Certificate.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/trusted_ca_lists/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"tunnels": {
"name": "tunnels",
"displayName": "Tunnels",
"operations": [
{
"name": "create_tunnel",
"description": "Create Tunnel.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/tunnels",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of tunnel",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.tunnel.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/schematunnelCreateSpecType"
}
],
"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 tunnelCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tunnelCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tunnelCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create tunnel in a given namespace. If one already exist it will give a error.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_ip": {
"type": "object",
"description": "Defines the OPTIONS to select local IP address and virtual network for tunnel object\nOPTIONS available are -\n1. Local Interface - Network Interface from which IP address and network will be selected\n2. IP Address - IP address and network can be configured explicitly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_ip.intf": {
"type": "object",
"description": "Provides the local interface to pick up source IP and network for transporting encapsulated packet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_ip.ip_address": {
"type": "object",
"description": "Provides the configuration to pick up source IP and network for transporting encapsulated packet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.params": {
"type": "object",
"description": "Tunnel configuration parameters for supported encapsulation\n1. IPsec is supported with PSK for which PSK can be configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.params.ipsec": {
"type": "object",
"description": "Configuration for IPsec encapsulation are:\n1. PSK - pre shared key to be used by IKE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.remote_ip": {
"type": "object",
"description": "Defines the OPTIONS to select remote IP address for tunnel object\nOPTIONS available are -\n1. IP Address - Specifies the remote IP to which tunnel has to be connected\n2. Remote endpoint - Is a map of IP address on per ver node basis.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.remote_ip.endpoints": {
"type": "object",
"description": "Provides a map of ver node name to remote node attributes\nVer node should use these attributes to configure as remote tunnel.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.remote_ip.ip": {
"type": "object",
"description": "IP Address used to specify an IPv4 or IPv6 address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_type": {
"type": "string",
"description": "Supported tunnel types are IPsec\n\nIPsec tunnel type with PSK\nGRE tunnel type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IPSEC_PSK"
}
},
"oneOfVariants": {
"spec.local_ip.type": [
"intf",
"ip_address"
],
"spec.local_ip.ip_address.type": [
"auto",
"ip_address"
],
"spec.params.type": [
"ipsec"
],
"spec.remote_ip.type": [
"endpoints",
"ip"
],
"spec.remote_ip.ip.ver": [
"ipv4",
"ipv6"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_tunnel",
"description": "Replace Tunnel.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/tunnels/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a tunnel",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.tunnel.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/schematunnelReplaceSpecType"
}
],
"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 tunnelReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tunnelReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for tunnelReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace tunnel in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_ip": {
"type": "object",
"description": "Defines the OPTIONS to select local IP address and virtual network for tunnel object\nOPTIONS available are -\n1. Local Interface - Network Interface from which IP address and network will be selected\n2. IP Address - IP address and network can be configured explicitly.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_ip.intf": {
"type": "object",
"description": "Provides the local interface to pick up source IP and network for transporting encapsulated packet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_ip.ip_address": {
"type": "object",
"description": "Provides the configuration to pick up source IP and network for transporting encapsulated packet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.params": {
"type": "object",
"description": "Tunnel configuration parameters for supported encapsulation\n1. IPsec is supported with PSK for which PSK can be configured.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.params.ipsec": {
"type": "object",
"description": "Configuration for IPsec encapsulation are:\n1. PSK - pre shared key to be used by IKE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.remote_ip": {
"type": "object",
"description": "Defines the OPTIONS to select remote IP address for tunnel object\nOPTIONS available are -\n1. IP Address - Specifies the remote IP to which tunnel has to be connected\n2. Remote endpoint - Is a map of IP address on per ver node basis.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.remote_ip.endpoints": {
"type": "object",
"description": "Provides a map of ver node name to remote node attributes\nVer node should use these attributes to configure as remote tunnel.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.remote_ip.ip": {
"type": "object",
"description": "IP Address used to specify an IPv4 or IPv6 address.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tunnel_type": {
"type": "string",
"description": "Supported tunnel types are IPsec\n\nIPsec tunnel type with PSK\nGRE tunnel type.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "IPSEC_PSK"
}
},
"oneOfVariants": {
"spec.local_ip.type": [
"intf",
"ip_address"
],
"spec.local_ip.ip_address.type": [
"auto",
"ip_address"
],
"spec.params.type": [
"ipsec"
],
"spec.remote_ip.type": [
"endpoints",
"ip"
],
"spec.remote_ip.ip.ver": [
"ipv4",
"ipv6"
]
}
},
{
"name": "list_tunnels",
"description": "List Tunnel.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/tunnels",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_tunnel",
"description": "DELETE Tunnel.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/tunnels/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a tunnel",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.tunnel.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for tunnelDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for tunnelDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_tunnel",
"description": "GET Tunnel.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/tunnels/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"udp-loadbalancers": {
"name": "udp-loadbalancers",
"displayName": "Udp Loadbalancers",
"operations": [
{
"name": "create_udp_loadbalancer",
"description": "Create UDP Load Balancer.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/udp_loadbalancers",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of udp_loadbalancer",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.udp_loadbalancer.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/viewsudp_loadbalancerCreateSpecType"
}
],
"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 udp_loadbalancerCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for udp_loadbalancerCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for udp_loadbalancerCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the UDP load balancer create specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public.public_ip": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nAs a prerequisite, the domain to be delegated to F5 Distributed Cloud using the Delegated Domain feature or a DNS CNAME record must be created in your DNS provider's portal.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of domains (host/authority header) that will be matched to this load balancer.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_random": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_source_ip_stickiness": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.idle_timeout": {
"type": "integer",
"description": "The amount of time that a session can exist without upstream or downstream activity, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.listen_port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nListen Port for this load balancer.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools_weights": {
"type": "array",
"description": "Origin pools with weights and priorities used for this load balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_ranges": {
"type": "string",
"description": "Exclusive with [listen_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
],
"spec.cluster_retract_choice": [],
"spec.hash_policy_choice": [
"hash_policy_choice_random",
"hash_policy_choice_round_robin",
"hash_policy_choice_source_ip_stickiness"
],
"spec.loadbalancer_type": [
"udp"
],
"spec.port_choice": [
"listen_port",
"port_ranges"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_udp_loadbalancer",
"description": "Replace UDP Load Balancer.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/udp_loadbalancers/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a udp_loadbalancer",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.udp_loadbalancer.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/viewsudp_loadbalancerReplaceSpecType"
}
],
"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 udp_loadbalancerReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for udp_loadbalancerReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for udp_loadbalancerReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the UDP load balancer replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies": {
"type": "object",
"description": "List of service policies.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.active_service_policies.policies": {
"type": "array",
"description": "Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\ncorrect order (policies evaluated from top to bottom in the list) for service policies, to GET the intended result.\nFor each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\ncurrent policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\nIf all policies are evaluated and none match, then the request will be denied by default.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_custom": {
"type": "object",
"description": "This defines a way to advertise a VIP on specific sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_custom.advertise_where": {
"type": "array",
"description": "Where should this load balancer be available.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.advertise_on_public": {
"type": "object",
"description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public.public_ip": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_on_public_default_vip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dns_volterra_managed": {
"type": "boolean",
"description": "DNS records for domains will be managed automatically by F5 Distributed Cloud.\nAs a prerequisite, the domain to be delegated to F5 Distributed Cloud using the Delegated Domain feature or a DNS CNAME record must be created in your DNS provider's portal.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of domains (host/authority header) that will be matched to this load balancer.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_random": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_round_robin": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.hash_policy_choice_source_ip_stickiness": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.idle_timeout": {
"type": "integer",
"description": "The amount of time that a session can exist without upstream or downstream activity, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.listen_port": {
"type": "integer",
"description": "Exclusive with [port_ranges]\nListen Port for this load balancer.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_service_policies": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.origin_pools_weights": {
"type": "array",
"description": "Origin pools with weights and priorities used for this load balancer.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.port_ranges": {
"type": "string",
"description": "Exclusive with [listen_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 512,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service_policies_from_namespace": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.udp": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.advertise_choice": [
"advertise_custom",
"advertise_on_public",
"advertise_on_public_default_vip",
"do_not_advertise"
],
"spec.cluster_retract_choice": [],
"spec.hash_policy_choice": [
"hash_policy_choice_random",
"hash_policy_choice_round_robin",
"hash_policy_choice_source_ip_stickiness"
],
"spec.loadbalancer_type": [
"udp"
],
"spec.port_choice": [
"listen_port",
"port_ranges"
],
"spec.service_policy_choice": [
"active_service_policies",
"no_service_policies",
"service_policies_from_namespace"
]
}
},
{
"name": "list_udp_loadbalancers",
"description": "List Configure UDP Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/udp_loadbalancers",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_udp_loadbalancer",
"description": "DELETE Configure UDP Load Balancer.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/udp_loadbalancers/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a udp_loadbalancer",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.udp_loadbalancer.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for udp_loadbalancerDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for udp_loadbalancerDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_udp_loadbalancer",
"description": "GET UDP Load Balancer.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/udp_loadbalancers/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"unlink-tickets": {
"name": "unlink-tickets",
"displayName": "Unlink Tickets",
"operations": [
{
"name": "create_unlink_ticket",
"description": "Unlink Tickets.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/unlink_tickets",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"title": "UnlinkTicketsRequest",
"x-displayname": "Unlink Tickets Request.",
"x-ves-oneof-field-unlink_choice": "[\"label_filter\",\"ticket_uid\"]",
"x-ves-proto-message": "ves.io.schema.virtual_host.UnlinkTicketsRequest",
"properties": {
"label_filter": {
"type": "string",
"description": "Exclusive with [ticket_uid]\nA LabelSelectorType expression for targeting which tickets to unlink.",
"title": "label_filter",
"maxLength": 8096,
"x-displayname": "Label Filter.",
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "8096"
},
"x-f5xc-example": "env in (staging, testing), tier in (web, db)",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "8096"
},
"x-f5xc-description-short": "Exclusive with [ticket_uid] A LabelSelectorType expression for targeting which tickets to unlink.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"maxLength": 256,
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "blogging-app-vhost",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the ticket.",
"title": "namespace",
"maxLength": 256,
"x-displayname": "Namespace",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "example-resource",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"ticket_uid": {
"type": "string",
"description": "Exclusive with [label_filter]\nThe UID of the tickets to be unlinked.",
"title": "Ticket UID",
"maxLength": 128,
"x-displayname": "Ticket UID.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "128"
},
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "128"
},
"x-f5xc-description-short": "Exclusive with [label_filter] The UID of the tickets to be unlinked.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostUnlinkTicketsRequest",
"required_fields": [
"name",
"namespace"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostUnlinkTicketsRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value"
}
},
"requiredFields": [
"name",
"namespace"
],
"description": "Minimum configuration for virtual_hostUnlinkTicketsRequest"
},
"fieldMetadata": {
"label_filter": {
"type": "string",
"description": "Exclusive with [ticket_uid]\nA LabelSelectorType expression for targeting which tickets to unlink.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the ticket.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"characterSet": {
"allowed": "[a-z0-9-]",
"restricted": "[^a-z0-9-]",
"required": "[a-z0-9]",
"description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end"
},
"format": "dns-label",
"formatDescription": "DNS-1035 label: must start with a lowercase letter",
"validation": {
"rfc": "RFC 1035",
"standard": "DNS-1035 label (alpha-first)"
},
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"ticket_uid": {
"type": "string",
"description": "Exclusive with [label_filter]\nThe UID of the tickets to be unlinked.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 128,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"unlink_choice": [
"label_filter",
"ticket_uid"
]
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors related to ticket unlink."
}
]
}
]
},
	"unmark-as-non-api": {
"name": "unmark-as-non-api",
      "displayName": "Unmark As Non Api",
      "operations": [
{
"name": "create_unmark_as_non_api",
      "description": "Unmark As Non-API.",
      "method": "POST",
"path": "/api/config/namespaces/{namespace}/api_definitions/{name}/unmark_as_non_api",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request shape for various API Inventory Requests.",
      "title": "API Inventory Request",
      "x-displayname": "API Inventory Request.",
      "x-ves-proto-message": "ves.io.schema.views.api_definition.APInventoryReq",
      "properties": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "title": "API Endpoints",
      "minItems": 1,
"maxItems": 100,
"items": {
"$ref": "#/components/schemas/viewsApiOperation"
      },
"x-displayname": "API Endpoints.",
      "x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "100",
"ves.io.schema.rules.repeated.min_items": "1"
},
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-description-short": "The list of API endpoints for the API Inventory request.",
      "x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "title": "Name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"x-f5xc-description-short": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request shape for various API Inventory Requests.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for api_definitionAPInventoryReq",
      "required_fields": [
"api_endpoints"
      ],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for api_definitionAPInventoryReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  api_endpoints: value",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"api_endpoints\": \"value\"\n  }\n}"
      },
"x-f5xc-cli-domain": "api"
      },
"responseSchema": {
"type": "object",
"properties": {
"updated_api_endpoints": {
      "type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"api_endpoints": "value"
      }
},
"requiredFields": [
"api_endpoints"
      ],
"description": "Minimum configuration for api_definitionAPInventoryReq"
      },
"fieldMetadata": {
"api_endpoints": {
      "type": "array",
"description": "The list of API endpoints for the API Inventory request.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 100,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "The name of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "The namespace of the API Definition for the current request.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "updated_api_endpoints",
      "type": "array",
"description": "The list of API endpoints which were successfully proceeded by the API Inventory request."
      }
]
}
]
},
	"update-allow-advertise-on-public": {
"name": "update-allow-advertise-on-public",
"displayName": "Update Allow Advertise On Public",
"operations": [
{
"name": "create_update_allow_advertise_on_public",
"description": "Update allow advertise on public.",
"method": "POST",
"path": "/api/config/namespaces/system/update_allow_advertise_on_public",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of UpdateAllowAdvertiseOnPublic request.",
"title": "UpdateAllowAdvertiseOnPublicReq",
"x-displayname": "Request for UpdateAllowAdvertiseOnPublic.",
"x-ves-proto-message": "ves.io.schema.namespace.UpdateAllowAdvertiseOnPublicReq",
"properties": {
"allow_advertise_on_public": {
"allOf": [
{
"$ref": "#/components/schemas/namespacePublicAdvertiseChoice"
}
],
"x-f5xc-description-short": "Configuration parameter for allow advertise on public.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Name of the namespace under which all the URLs in APIItems will be evaluated.",
      "title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Name of the namespace under which all the URLs in APIItems will be evaluated.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request body of UpdateAllowAdvertiseOnPublic request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceUpdateAllowAdvertiseOnPublicReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceUpdateAllowAdvertiseOnPublicReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceUpdateAllowAdvertiseOnPublicReq"
},
"fieldMetadata": {
"allow_advertise_on_public": {
"type": "string",
"description": "Enum for advertisement choice on public.\n\nInherit tenant's default.\nEnable enables advertisement on public.\nDisable disables advertisement on public.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "Default"
},
"namespace": {
"type": "string",
"description": "Name of the namespace under which all the URLs in APIItems will be evaluated.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "result",
"type": "boolean",
"description": "API result."
      }
]
}
]
},
	"upgrade-os": {
"name": "upgrade-os",
"displayName": "Upgrade Os",
"operations": [
{
"name": "create_upgrade_o",
"description": "Upgrade OS.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/sites/{name}/upgrade_os",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Upgrade OS of Site.",
"title": "Upgrade OS request",
"x-displayname": "Upgrade OS Request.",
"x-ves-proto-message": "ves.io.schema.site.UpgradeOSRequest",
"properties": {
"force": {
"type": "boolean",
"description": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress)",
"title": "Force",
"format": "boolean",
"x-displayname": "Force",
"x-ves-required": "false",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "false"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "true",
"x-f5xc-description-short": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e.",
"x-f5xc-description-medium": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Site name",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Ce398",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ce398",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Site namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "Version to upgraded to.",
"title": "SW/OS Version",
"x-displayname": "Version",
"x-ves-example": "7.2003.20",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "7.2003.20",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteUpgradeOSRequest",
"required_fields": [
"name",
"namespace",
"version"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteUpgradeOSRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  version: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"version\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"version": "value"
}
},
"requiredFields": [
"name",
"namespace",
"version"
],
"description": "Minimum configuration for siteUpgradeOSRequest"
},
"fieldMetadata": {
"force": {
"type": "boolean",
"description": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Site name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Site namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "Version to upgraded to.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"upgrade-status": {
"name": "upgrade-status",
"displayName": "Upgrade Status",
"operations": [
{
"name": "list_upgrade_status",
"description": "Upgrade Status.",
"method": "GET",
"path": "/api/data/namespaces/system/upgrade_status",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "upgrade_in_progress",
"type": "object",
"description": ""
},
{
"field": "upgrade_in_progress_with_config_downtime",
"type": "object",
"description": ""
},
{
"field": "upgrade_not_in_progress",
"type": "object",
"description": ""
}
]
}
]
},
	"upgrade-sw": {
"name": "upgrade-sw",
"displayName": "Upgrade Sw",
"operations": [
{
"name": "create_upgrade_sw",
"description": "Upgrade SW.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/sites/{name}/upgrade_sw",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request for Upgrade SW of Site.",
"title": "Upgrade SW request",
"x-displayname": "Upgrade SW Request.",
"x-ves-proto-message": "ves.io.schema.site.UpgradeSWRequest",
"properties": {
"force": {
"type": "boolean",
"description": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress)",
"title": "Force",
"format": "boolean",
"x-displayname": "Force",
"x-ves-required": "false",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "false"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "true",
"x-f5xc-description-short": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e.",
"x-f5xc-description-medium": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress).",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Site name",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "Ce398",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "ce398",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Site namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"version": {
"type": "string",
"description": "Version to upgraded to.",
"title": "SW/OS Version",
"x-displayname": "Version",
"x-ves-example": "Crt-20201010-600.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "crt-20201010-600",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for siteUpgradeSWRequest",
"required_fields": [
"name",
"namespace",
"version"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for siteUpgradeSWRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  name: value\n  namespace: value\n  version: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"name\": \"value\",\n    \"namespace\": \"value\",\n    \"version\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"name": "value",
"namespace": "value",
"version": "value"
}
},
"requiredFields": [
"name",
"namespace",
"version"
],
"description": "Minimum configuration for siteUpgradeSWRequest"
},
"fieldMetadata": {
"force": {
"type": "boolean",
"description": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Site name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Site namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"version": {
"type": "string",
"description": "Version to upgraded to.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
}
]
},
	"usage": {
"name": "usage",
"displayName": "Usage",
"operations": [
{
"name": "create_usage",
"description": "Usage Metrics.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/workloads/usage",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to GET workload usage in the given namespace.",
"title": "Usage Request",
"x-displayname": "Usage Request.",
"x-ves-proto-message": "ves.io.schema.views.workload.UsageRequest",
"properties": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "End time",
"x-displayname": "End Time",
"x-ves-example": "1570197600.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570197600",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.",
"title": "Field Selector",
"minItems": 1,
"maxItems": 8,
"items": {
"$ref": "#/components/schemas/viewsworkloadUsageType"
},
"x-displayname": "Field Selector.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true",
"ves.io.schema.rules.repeated.max_items": "8",
"ves.io.schema.rules.repeated.min_items": "1",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.",
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in UsageLabel {CONTAINER, POD, SITE} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all workloads usage in the given namespace will be aggregated based on the group_by field.",
"title": "Label Filter",
"x-displayname": "Filter",
"x-ves-example": "{POD=\\\"pod-1\\\"}",
"x-f5xc-example": "\"{POD=\\\"pod-1\\\"}\"",
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in UsageLabel {CONTAINER, POD, SITE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = ...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {NAMESPACE, CONTAINER, POD, SITE}",
"title": "Group by",
"items": {
"$ref": "#/components/schemas/workloadUsageLabel"
},
"x-displayname": "Group By",
"x-f5xc-description-short": "Aggregate data by zero or more labels {NAMESPACE, CONTAINER, POD, SITE}.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"include_system_workloads": {
"type": "boolean",
"description": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should be included in the response.\nThis field is applicable only in the `system` namespace where the response contains data across all namespaces.\n\nOptional: If not specified, only the workloads running in the customer namespaces would be returned in the response.",
"title": "Include System Workloads",
"format": "boolean",
"x-displayname": "Include System Workloads.",
"x-f5xc-description-short": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should...",
"x-f5xc-description-medium": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should be included in the response. This field is applicable only in the namespace where the response contains data across all namespaces. Optional: If not...",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the workload usage to a given namespace.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Ns1",
"x-f5xc-example": "ns1",
"x-f5xc-description-short": "Namespace is used to scope the workload usage to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"title": "Range",
"x-displayname": "Range",
"x-ves-example": "10m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-example": "10m",
"x-validation-rules": {
"ves.io.schema.rules.string.time_interval": "true"
},
"x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
"x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "Start time",
"x-displayname": "Start Time.",
"x-ves-example": "1570194000.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "1570194000",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"title": "Step",
"x-displayname": "Step",
"x-ves-example": "5m",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-example": "5m",
"x-validation-rules": {
"ves.io.schema.rules.string.query_step": "true"
},
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to GET workload usage in the given namespace.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for workloadUsageRequest",
"required_fields": [
"field_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workloadUsageRequest\nmetadata:\n  name: example\n  namespace: default\nspec:\n  field_selector: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"field_selector\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {
"data": {
"type": "array"
},
"step": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"field_selector": "value"
}
},
"requiredFields": [
"field_selector"
],
"description": "Minimum configuration for workloadUsageRequest"
},
"fieldMetadata": {
"end_time": {
"type": "string",
"description": "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"field_selector": {
"type": "array",
"description": "Select fields to be returned in the response.\nOne or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 8,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"filter": {
"type": "string",
"description": "Filter is used to specify the list of matchers\nsyntax for filter := {[<matcher>]}\n<matcher> := <label><operator>\"<value>\"\n<label> := string\nOne or more labels defined in UsageLabel {CONTAINER, POD, SITE} can be specified in the filter.\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all workloads usage in the given namespace will be aggregated based on the group_by field.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"group_by": {
"type": "array",
"description": "Aggregate data by zero or more labels {NAMESPACE, CONTAINER, POD, SITE}",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"include_system_workloads": {
"type": "boolean",
"description": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should be included in the response.\nThis field is applicable only in the `system` namespace where the response contains data across all namespaces.\n\nOptional: If not specified, only the workloads running in the customer namespaces would be returned in the response.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is used to scope the workload usage to a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"range": {
"type": "string",
"description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"step": {
"type": "string",
"description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to <end_time - start_time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "data",
"type": "array",
"description": "Data contains time-series data for the workload usage."
},
{
"field": "step",
"type": "string",
"description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days."
}
]
},
{
"name": "list_usage",
"description": "GET Quota Usage.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/quota/usage",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"responseSchema": {
"type": "object",
"properties": {
"api_limits": {
      "type": "object"
},
"apis": {
      "type": "object"
},
"float_quota_usage": {
"type": "object"
},
"objects": {
"type": "object"
},
"quota_usage": {
"type": "object"
},
"resources": {
"type": "object"
}
}
},
"responseSummary": [
{
"field": "api_limits",
      "type": "object",
"description": "APILimits object.\nDeprecated by 'APIs'"
      },
{
"field": "apis",
      "type": "object",
"description": "Configured rate limits for APIs."
      },
{
"field": "float_quota_usage",
"type": "object",
"description": "UsageDataInFloat object.\nDeprecated by 'resources'"
},
{
"field": "objects",
"type": "object",
"description": "Configured limits for object instances and current usage."
},
{
"field": "quota_usage",
"type": "object",
"description": "UsageData object.\nDeprecated by 'objects'"
},
{
"field": "resources",
"type": "object",
"description": "Configured limits for resources and current usage if relevant."
}
]
}
]
},
	"usage-details": {
"name": "usage-details",
"displayName": "Usage Details",
"operations": [
{
"name": "create_usage_detail",
"description": "List usage details.",
"method": "POST",
"path": "/api/web/namespaces/{namespace}/usage_details",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request message to GET usage details.",
"title": "List usage details request",
"x-displayname": "List usage details request.",
"x-ves-proto-message": "ves.io.schema.usage.ListUsageDetailsReq",
"properties": {
"from": {
"type": "string",
"description": "Indicates the \"from\" part of the request.",
"title": "Timestamp from",
"format": "date-time",
"x-displayname": "From",
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
"x-f5xc-description-short": "Indicates the \"from\" part of the request.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to be considered.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"x-f5xc-example": "system",
"x-validation-rules": {
"ves.io.schema.rules.string.const": "system"
},
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"to": {
"type": "string",
"description": "Indicates the \"to\" part of the request.",
"title": "Timestamp to",
"format": "date-time",
"x-displayname": "To",
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usageListUsageDetailsReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usageListUsageDetailsReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "billing_and_usage"
},
"responseSchema": {
"type": "object",
"properties": {
"usage_items": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usageListUsageDetailsReq"
},
"fieldMetadata": {
"from": {
"type": "string",
"description": "Indicates the \"from\" part of the request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace to be considered.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"to": {
"type": "string",
"description": "Indicates the \"to\" part of the request.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "date-time",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "usage_items",
"type": "array",
"description": "Collection of usage items, lines of response."
}
]
}
]
},
	"usage-plans-current": {
"name": "usage-plans-current",
"displayName": "Usage Plans Current",
"operations": [
{
"name": "list_usage_plans_current",
"description": "GET current usage plan.",
"method": "GET",
"path": "/api/web/namespaces/system/usage_plans/current",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"locale": {
"type": "string"
},
"plans": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "locale",
"type": "string",
"description": "Locale in the ISO dashed format."
},
{
"field": "plans",
"type": "array",
"description": "Collection of currently publicly available plans."
}
]
}
]
},
	"usage-plans-custom-list": {
"name": "usage-plans-custom-list",
"displayName": "Usage Plans Custom List",
"operations": [
{
"name": "list_usage_plans_custom_list",
"description": "List Usage Plans.",
"method": "GET",
"path": "/api/web/namespaces/system/usage_plans/custom_list",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"usage_plans": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "usage_plans",
"type": "array",
"description": "Collection of available plans."
}
]
}
]
},
	"usb-policys": {
"name": "usb-policys",
"displayName": "Usb Policys",
"operations": [
{
"name": "create_usb_policy",
"description": "Create USB policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/usb_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of usb_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.usb_policy.CreateRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectCreateMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/usb_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usb_policyCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usb_policyCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usb_policyCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates a new USB policy object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_devices": {
"type": "array",
"description": "List of allowed USB devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_usb_policy",
"description": "Replace USB policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/usb_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a usb_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.usb_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/usb_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usb_policyReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usb_policyReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usb_policyReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replaces the content of an USB policy object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allowed_devices": {
"type": "array",
"description": "List of allowed USB devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_usb_policys",
"description": "List USB policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/usb_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_usb_policy",
"description": "DELETE USB policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/usb_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a usb_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.usb_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usb_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usb_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "ce_management"
}
},
{
"name": "get_usb_policy",
"description": "GET USB policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/usb_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"user-admin-notifications": {
"name": "user-admin-notifications",
"displayName": "User Admin Notifications",
"operations": [
{
"name": "list_user_admin_notifications",
"description": "GET admin ntfn preferences.",
"method": "GET",
"path": "/api/web/namespaces/system/user/admin_notifications",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"notifications": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "notifications",
"type": "array",
"description": "List of notifications."
}
]
},
{
"name": "replace_user_admin_notification",
"description": "Update admin ntfn preferences.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/admin_notifications",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Notification preferences information.",
"title": "Notification preferences",
"x-displayname": "Notification preferences.",
"x-ves-proto-message": "ves.io.schema.user.setting.NtfnPreferencesMap",
"properties": {
"ntfn_preferences_map": {
"type": "object",
"description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"title": "Ntfn preferences map",
"x-displayname": "Ntfn preferences map.",
"x-ves-example": "['notif-1':false]",
"x-f5xc-example": "['notif-1':false]",
"x-f5xc-description-short": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"x-f5xc-description-medium": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingNtfnPreferencesMap",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingNtfnPreferencesMap\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingNtfnPreferencesMap"
},
"fieldMetadata": {
"ntfn_preferences_map": {
"type": "object",
"description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-admin-notifications-unset": {
"name": "user-admin-notifications-unset",
"displayName": "User Admin Notifications Unset",
"operations": [
{
"name": "replace_user_admin_notifications_unset",
"description": "Unset admin ntfn preference.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/admin_notifications/unset",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Notification to unset.",
"title": "Notification unset",
"x-displayname": "Notification unset.",
"x-ves-proto-message": "ves.io.schema.user.setting.NtfnToUnset",
"properties": {
"ntfn_to_unset": {
"type": "string",
"description": "Ntfn to unset contains notification which should be unset for particular user.",
"title": "Ntfn to unset",
"x-displayname": "Ntfn to unset.",
"x-ves-example": "Notif-1",
"x-f5xc-example": "notif-1",
"x-f5xc-description-short": "Ntfn to unset contains notification which should be unset for particular user.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingNtfnToUnset",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingNtfnToUnset\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingNtfnToUnset"
},
"fieldMetadata": {
"ntfn_to_unset": {
"type": "string",
"description": "Ntfn to unset contains notification which should be unset for particular user.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-combined-notifications": {
"name": "user-combined-notifications",
"displayName": "User Combined Notifications",
"operations": [
{
"name": "list_user_combined_notifications",
"description": "GET combined ntfn preferences.",
"method": "GET",
"path": "/api/web/namespaces/system/user/combined_notifications",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"notifications": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "notifications",
"type": "array",
"description": "List of notifications."
}
]
},
{
"name": "replace_user_combined_notification",
"description": "Update combined ntfn preferences.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/combined_notifications",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Notification preferences information.",
"title": "Notification preferences",
"x-displayname": "Notification preferences.",
"x-ves-proto-message": "ves.io.schema.user.setting.NtfnPreferencesMap",
"properties": {
"ntfn_preferences_map": {
"type": "object",
"description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"title": "Ntfn preferences map",
"x-displayname": "Ntfn preferences map.",
"x-ves-example": "['notif-1':false]",
"x-f5xc-example": "['notif-1':false]",
"x-f5xc-description-short": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"x-f5xc-description-medium": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingNtfnPreferencesMap",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingNtfnPreferencesMap\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingNtfnPreferencesMap"
},
"fieldMetadata": {
"ntfn_preferences_map": {
"type": "object",
"description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-groups": {
"name": "user-groups",
"displayName": "User Groups",
"operations": [
{
"name": "list_user_groups",
"description": "List User Group.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/user_groups",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "get_user_group",
"description": "GET User Group.",
"method": "GET",
"path": "/api/web/namespaces/{namespace}/user_groups/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
}
]
},
	"user-identifications": {
"name": "user-identifications",
"displayName": "User Identifications",
"operations": [
{
"name": "create_user_identification",
"description": "Create User Identification.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/user_identifications",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of user_identification",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.user_identification.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/user_identificationCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "User identification rules for bot defense and rate limiting",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.rules"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: user_identification\nmetadata:\n  name: example-user-id\n  namespace: default\nspec:\n  rules:\n    - client_ip: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-user-id\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"rules\": [{\"client_ip\": {}}]\n  }\n}\n"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-user-id",
"namespace": "default"
},
"spec": {
"rules": [
{
"client_ip": {}
}
]
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.rules"
],
"description": "User identification rules for bot defense and rate limiting"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create user_identification creates a new object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "An ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.\nEvaluation of the rules is terminated once a user identifier has been extracted.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_user_identification",
"description": "Replace User Identification.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/user_identifications/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a user_identification",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.user_identification.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/user_identificationReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "User identification rules for bot defense and rate limiting",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.rules"
],
"mutually_exclusive_groups": [],
"example_yaml": "apiVersion: v1\nkind: user_identification\nmetadata:\n  name: example-user-id\n  namespace: default\nspec:\n  rules:\n    - client_ip: {}\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-user-id\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"rules\": [{\"client_ip\": {}}]\n  }\n}\n"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-user-id",
"namespace": "default"
},
"spec": {
"rules": [
{
"client_ip": {}
}
]
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.rules"
],
"description": "User identification rules for bot defense and rate limiting"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace user_identification replaces an existing object in the storage backend for metadata.namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.rules": {
"type": "array",
"description": "An ordered list of rules that are evaluated sequentially against the input fields extracted from an API request in order to determine a user identifier.\nEvaluation of the rules is terminated once a user identifier has been extracted.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_user_identifications",
"description": "List User Identification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/user_identifications",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_user_identification",
"description": "DELETE User Identification.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/user_identifications/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a user_identification",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.user_identification.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for user_identificationDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for user_identificationDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
}
},
{
"name": "get_user_identification",
"description": "GET User Identification.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/user_identifications/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"user-notifications": {
"name": "user-notifications",
"displayName": "User Notifications",
"operations": [
{
"name": "list_user_notifications",
"description": "GET ntfn preferences.",
"method": "GET",
"path": "/api/web/namespaces/system/user/notifications",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"notifications": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "notifications",
"type": "array",
"description": "List of notifications."
}
]
},
{
"name": "replace_user_notification",
"description": "Update ntfn preferences.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/notifications",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Notification preferences information.",
"title": "Notification preferences",
"x-displayname": "Notification preferences.",
"x-ves-proto-message": "ves.io.schema.user.setting.NtfnPreferencesMap",
"properties": {
"ntfn_preferences_map": {
"type": "object",
"description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"title": "Ntfn preferences map",
"x-displayname": "Ntfn preferences map.",
"x-ves-example": "['notif-1':false]",
"x-f5xc-example": "['notif-1':false]",
"x-f5xc-description-short": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"x-f5xc-description-medium": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingNtfnPreferencesMap",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingNtfnPreferencesMap\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingNtfnPreferencesMap"
},
"fieldMetadata": {
"ntfn_preferences_map": {
"type": "object",
"description": "Ntfn preferences map contains information whether user is enabled or disabled specific notification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-notifications-unset": {
"name": "user-notifications-unset",
"displayName": "User Notifications Unset",
"operations": [
{
"name": "replace_user_notifications_unset",
"description": "Unset ntfn preference.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/notifications/unset",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Notification to unset.",
"title": "Notification unset",
"x-displayname": "Notification unset.",
"x-ves-proto-message": "ves.io.schema.user.setting.NtfnToUnset",
"properties": {
"ntfn_to_unset": {
"type": "string",
"description": "Ntfn to unset contains notification which should be unset for particular user.",
"title": "Ntfn to unset",
"x-displayname": "Ntfn to unset.",
"x-ves-example": "Notif-1",
"x-f5xc-example": "notif-1",
"x-f5xc-description-short": "Ntfn to unset contains notification which should be unset for particular user.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingNtfnToUnset",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingNtfnToUnset\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingNtfnToUnset"
},
"fieldMetadata": {
"ntfn_to_unset": {
"type": "string",
"description": "Ntfn to unset contains notification which should be unset for particular user.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-otp-admin-reset": {
"name": "user-otp-admin-reset",
"displayName": "User Otp Admin Reset",
"operations": [
{
"name": "replace_user_otp_admin_reset",
"description": "ResetOtpDeviceByAdmin.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/otp/admin_reset",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Email",
"title": "Email",
"x-displayname": "Email",
"x-ves-proto-message": "ves.io.schema.user.setting.UserEmail",
"properties": {
"user_email": {
"type": "string",
"description": "Configuration parameter for user email",
"title": "Email",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingUserEmail",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingUserEmail\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingUserEmail"
},
"fieldMetadata": {
"user_email": {
"type": "string",
"description": "Configuration parameter for user email",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-sessions": {
"name": "user-sessions",
"displayName": "User Sessions",
"operations": [
{
"name": "list_user_sessions",
"description": "GetUserSessions.",
"method": "GET",
"path": "/api/web/namespaces/system/user/sessions",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"user_sessions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "user_sessions",
"type": "array",
"description": "UserSessions contains list of user sessions."
}
]
}
]
},
	"user-settings": {
"name": "user-settings",
"displayName": "User Settings",
"operations": [
{
"name": "list_user_settings",
"description": "GET",
"method": "GET",
"path": "/api/web/namespaces/system/user/settings",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"image": {
"type": "string"
},
"is_next_request_allowed": {
"type": "boolean"
},
"notifications": {
"type": "array"
},
"otp_enabled": {
"type": "boolean"
}
}
},
"responseSummary": [
{
"field": "image",
"type": "string",
"description": "Image blob field stores user's image, should be base64 encoded while used by HTTP."
},
{
"field": "initial_access",
      "type": "object",
"description": ""
},
{
"field": "is_next_request_allowed",
"type": "boolean",
"description": "Boolean flag which shows whether RE-request access is allowed or not.\nVirtually flag shows whether 24hrs are passed from the last_requesting_time timestamp or not."
      },
{
"field": "notifications",
"type": "array",
"description": "List of enabled notifications for specific user account."
},
{
"field": "otp_enabled",
"type": "boolean",
"description": "Switcher for configuration of enabling OTP in IAM Provider."
},
{
"field": "otp_status",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_user_setting",
"description": "Update",
"method": "PUT",
"path": "/api/web/namespaces/system/user/settings",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Allowed settings for the user to be modified.",
"title": "UserSettingsRequest",
"x-displayname": "UserSettingsRequest.",
"x-ves-proto-message": "ves.io.schema.user.setting.UserSettingsRequest",
"properties": {
"enabled_notifications": {
"type": "array",
"description": "Enabled notification for specific user.",
"title": "Enabled Notifications",
"items": {
"type": "string"
},
"x-displayname": "Enabled Notifications.",
"x-ves-example": "['notif-1','notif-2']",
"x-f5xc-example": "['notif-1','notif-2']",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"first_name": {
"type": "string",
"description": "First name of the user.",
"title": "First Name",
"x-displayname": "First Name.",
"x-ves-example": "Joe",
"x-f5xc-example": "Joe",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"image": {
"type": "string",
"description": "Blob of the user avatar image.",
"title": "Image",
"format": "byte",
"x-displayname": "Image",
"x-ves-example": "DXNlci1pbWFnZS5qcGVn.",
"x-f5xc-example": "dXNlci1pbWFnZS5qcGVn",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"last_name": {
"type": "string",
"description": "Last Name of the user.",
"title": "Last Name",
"x-displayname": "Last Name",
"x-ves-example": "Doe",
"x-f5xc-example": "Doe",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"otp_enabled": {
"type": "boolean",
"description": "OTP enabled flag.",
"title": "OTP enable",
"format": "boolean",
"x-displayname": "OTP enabled.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Allowed settings for the user to be modified.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingUserSettingsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingUserSettingsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingUserSettingsRequest"
},
"fieldMetadata": {
"enabled_notifications": {
"type": "array",
"description": "Enabled notification for specific user.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"first_name": {
"type": "string",
"description": "First name of the user.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"image": {
"type": "string",
"description": "Blob of the user avatar image.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"last_name": {
"type": "string",
"description": "Last Name of the user.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"otp_enabled": {
"type": "boolean",
"description": "OTP enabled flag.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-settings-idm-disable": {
"name": "user-settings-idm-disable",
"displayName": "User Settings Idm Disable",
"operations": [
{
"name": "replace_user_settings_idm_disable",
"description": "DisableUserInIDM.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/settings/idm/disable",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Email",
"title": "Email",
"x-displayname": "Email",
"x-ves-proto-message": "ves.io.schema.user.setting.UserEmail",
"properties": {
"user_email": {
"type": "string",
"description": "Configuration parameter for user email",
"title": "Email",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingUserEmail",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingUserEmail\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingUserEmail"
},
"fieldMetadata": {
"user_email": {
"type": "string",
"description": "Configuration parameter for user email",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-settings-idm-enable": {
"name": "user-settings-idm-enable",
"displayName": "User Settings Idm Enable",
"operations": [
{
"name": "replace_user_settings_idm_enable",
"description": "EnableUserInIDM.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/settings/idm/enable",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Email",
"title": "Email",
"x-displayname": "Email",
"x-ves-proto-message": "ves.io.schema.user.setting.UserEmail",
"properties": {
"user_email": {
"type": "string",
"description": "Configuration parameter for user email",
"title": "Email",
"x-displayname": "Email",
"x-ves-example": "Dana@example.com.",
"x-f5xc-example": "dana@example.com",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingUserEmail",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingUserEmail\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingUserEmail"
},
"fieldMetadata": {
"user_email": {
"type": "string",
"description": "Configuration parameter for user email",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-settings-image": {
"name": "user-settings-image",
"displayName": "User Settings Image",
"operations": [
{
"name": "delete_user_settings_image",
"description": "DeleteUserImage.",
"method": "DELETE",
"path": "/api/web/namespaces/system/user/settings/image",
      "dangerLevel": "high",
"parameters": [],
"responseSchema": {
"type": "object"
}
},
{
"name": "list_user_settings_image",
"description": "GetUserProfileImage.",
"method": "GET",
"path": "/api/web/namespaces/system/user/settings/image",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"content_type": {
"type": "string"
},
"data": {
"type": "string"
},
"extensions": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "content_type",
"type": "string",
"description": "The HTTP Content-Type header value specifying the content type of the body."
},
{
"field": "data",
"type": "string",
"description": "The HTTP request/response body as raw binary."
},
{
"field": "extensions",
"type": "array",
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
      }
]
},
{
"name": "replace_user_settings_image",
"description": "UpdateUserImage.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/settings/image",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Message contains data for updating user profile image.",
"title": "UpdateImageRequest",
"x-displayname": "UpdateImageRequest.",
"x-ves-proto-message": "ves.io.schema.user.setting.UpdateImageRequest",
"properties": {
"content_type": {
"type": "string",
"description": "Type of uploading image.",
"x-displayname": "ContentType.",
"x-ves-example": "Image/jpeg.",
"x-f5xc-example": "image/jpeg",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"image": {
"type": "string",
"description": "Blob of the user profile image.",
"format": "byte",
"x-displayname": "Image",
"x-ves-example": "DXNlci1pbWFnZS5qcGVn.",
"x-f5xc-example": "dXNlci1pbWFnZS5qcGVn",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Message contains data for updating user profile image.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingUpdateImageRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingUpdateImageRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingUpdateImageRequest"
},
"fieldMetadata": {
"content_type": {
"type": "string",
"description": "Type of uploading image.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"image": {
"type": "string",
"description": "Blob of the user profile image.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "byte",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"user-settings-request-initial-access": {
"name": "user-settings-request-initial-access",
      "displayName": "User Settings Request Initial Access",
      "operations": [
{
"name": "replace_user_settings_request_initial_acce",
"description": "Request Initial Access.",
      "method": "PUT",
"path": "/api/web/namespaces/system/user/settings/request_initial_access",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Empty object definition.",
"title": "Empty",
"x-displayname": "Empty",
"x-ves-proto-message": "ves.io.schema.user.setting.Empty",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for usersettingEmpty",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for usersettingEmpty\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for usersettingEmpty"
}
}
]
},
	"user-settings-view-preference": {
"name": "user-settings-view-preference",
"displayName": "User Settings View Preference",
"operations": [
{
"name": "list_user_settings_view_preference",
"description": "GET view preference.",
"method": "GET",
"path": "/api/web/namespaces/system/user/settings/view_preference",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"advanced_view": {
"type": "boolean"
},
"initialized": {
"type": "boolean"
},
"wizard_advanced_auto_expand": {
"type": "boolean"
}
}
},
"responseSummary": [
{
"field": "advanced_view",
"type": "boolean",
"description": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed."
},
{
"field": "initialized",
"type": "boolean",
"description": "If true then the user picked their preference."
},
{
"field": "persona_preferences",
"type": "object",
"description": ""
},
{
"field": "wizard_advanced_auto_expand",
"type": "boolean",
"description": "If true then all advanced configuration fields are automatically expanded when creating a new object."
}
]
},
{
"name": "replace_user_settings_view_preference",
"description": "Set view preference.",
"method": "PUT",
"path": "/api/web/namespaces/system/user/settings/view_preference",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "User console view preferences.",
"title": "View preference",
"x-displayname": "View preference.",
"x-ves-proto-message": "ves.io.schema.user.setting.SetViewPreferenceRequest",
"properties": {
"advanced_view": {
"type": "boolean",
"description": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.",
"title": "Advanced view",
"format": "boolean",
"x-displayname": "Advanced view.",
"x-f5xc-description-short": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences": {
"allOf": [
{
"$ref": "#/components/schemas/settingPersonaPreferences"
}
],
"x-f5xc-description-short": "Configuration parameter for persona preferences.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"wizard_advanced_auto_expand": {
"type": "boolean",
"description": "If true then all advanced configuration fields are automatically expanded when creating a new object.",
"title": "Advanced fields auto-expand",
"format": "boolean",
"x-displayname": "Advanced fields auto-expand.",
"x-f5xc-description-short": "If true then all advanced configuration fields are automatically expanded when creating a new object.",
"x-f5xc-description-medium": "If true then all advanced configuration fields are automatically expanded when creating a new object.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for settingSetViewPreferenceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for settingSetViewPreferenceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for settingSetViewPreferenceRequest"
},
"fieldMetadata": {
"advanced_view": {
"type": "boolean",
"description": "If true then more OPTIONS are displayed, otherwise a simplified view is displayed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences": {
"type": "object",
"description": "Preferences to display appropriate content to appropriate audience.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences.billing": {
"type": "boolean",
"description": "Audience is a billing admin.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences.dev_ops": {
"type": "boolean",
"description": "Audience is DevOps.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences.developer": {
"type": "boolean",
"description": "Audience is a developer.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences.master": {
"type": "boolean",
"description": "Audience is an admin.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences.net_ops": {
"type": "boolean",
"description": "Audience is NetOps.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"persona_preferences.sec_ops": {
"type": "boolean",
"description": "Audience is SecOps.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"wizard_advanced_auto_expand": {
"type": "boolean",
"description": "If true then all advanced configuration fields are automatically expanded when creating a new object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"validate-config": {
"name": "validate-config",
"displayName": "Validate Config",
"operations": [
{
"name": "create_validate_config",
"description": "Validate AWS TGW Config.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/validate_config",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request to validate AWS VPC site configuration.",
"title": "Request to validate AWS VPC site configuration",
"x-displayname": "Request to validate AWS VPC site configuration.",
"x-ves-proto-message": "ves.io.schema.views.ValidateConfigRequest",
"properties": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "AWS-VPC-site-1.",
"x-f5xc-example": "aws-vpc-site-1",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Default",
"x-f5xc-example": "default",
"x-f5xc-description-short": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request to validate AWS VPC site configuration.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for viewsValidateConfigRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for viewsValidateConfigRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "certificates"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for viewsValidateConfigRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name of the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace for the object to be configured.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"validate-rules": {
"name": "validate-rules",
"displayName": "Validate Rules",
"operations": [
{
"name": "create_validate_rule",
"description": "Validate Rules.",
"method": "POST",
"path": "/api/config/namespaces/system/validate_rules",
      "dangerLevel": "medium",
"parameters": [],
"bodySchema": {
"type": "object",
"description": "Request body of ValidateRulesReq request.",
"title": "ValidateRulesReq",
"x-displayname": "Request for validating according to rules specified in the validator_evaluation.",
"x-ves-proto-message": "ves.io.schema.namespace.ValidateRulesReq",
"properties": {
"namespace": {
"type": "string",
"description": "The name of the namespace which will be system in this case.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "The name of the namespace which will be system in this case.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"validator_evaluation": {
"type": "object",
"description": "Map contains validators which needs to be evaluated.",
"title": "validator evaluation",
"x-displayname": "Validator evaluation.",
"x-ves-example": "The map key would be the validator type e.g. XStringRegex and the map value is the validator value e.g. True.",
      "x-f5xc-example": "The map key would be the validator type e.g. XStringRegex and the map value is the validator value e.g. true",
      "x-f5xc-description-short": "Map contains validators which needs to be evaluated.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"value": {
"type": "string",
"description": "The value to be validated.",
"title": "value",
"x-displayname": "Value",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request body of ValidateRulesReq request.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for namespaceValidateRulesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for namespaceValidateRulesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
},
"validation_results": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for namespaceValidateRulesReq"
},
"fieldMetadata": {
"namespace": {
"type": "string",
"description": "The name of the namespace which will be system in this case.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"validator_evaluation": {
"type": "object",
"description": "Map contains validators which needs to be evaluated.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"value": {
"type": "string",
"description": "The value to be validated.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "error",
"type": "string",
"description": "Error returned in case the value does not match the validator rules."
},
{
"field": "success",
"type": "boolean",
"description": "This will set true if validation is successful on value."
},
{
"field": "validation_results",
"type": "array",
"description": "This will return a list of validation results based on validators passed as input."
}
]
}
]
},
	"verify": {
"name": "verify",
"displayName": "Verify",
"operations": [
{
"name": "create_verify",
"description": "Verify DNS Domain.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/dns_domain/{name}/verify",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "DNS domain request verification shape.",
"title": "Verify DNS Domain Request",
"x-displayname": "Verify DNS Domain.",
"x-ves-proto-message": "ves.io.schema.dns_domain.VerifyDnsDomainRequest",
"properties": {
"name": {
"type": "string",
"description": "Name dns_domain object, which also domain name.",
"title": "Name",
"x-displayname": "Name",
"x-ves-example": "example.com.",
"x-f5xc-example": "example.com",
"x-f5xc-description-short": "Name dns_domain object, which also domain name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace is always system for dns_domain.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"x-f5xc-description-short": "Namespace is always system for dns_domain.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for dns_domainVerifyDnsDomainRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for dns_domainVerifyDnsDomainRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "dns"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for dns_domainVerifyDnsDomainRequest"
},
"fieldMetadata": {
"name": {
"type": "string",
"description": "Name dns_domain object, which also domain name.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace is always system for dns_domain.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"view-internal": {
"name": "view-internal",
"displayName": "View Internal",
"operations": [
{
"name": "get_view_internal",
"description": "GET Internal object for view.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/view_internal/{view_kind}/{view_name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "view_kind",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "view_name",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {}
},
"responseSummary": [
{
"field": "view_internal",
"type": "object",
"description": ""
}
]
}
]
},
	"virtual-hosts": {
"name": "virtual-hosts",
"displayName": "Virtual Hosts",
"operations": [
{
"name": "create_virtual_host",
"description": "Create Virtual Host.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/virtual_hosts",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of virtual_host",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.virtual_host.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/schemavirtual_hostCreateSpecType"
}
],
"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 virtual_hostCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Creates virtual host in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.add_location": {
"type": "boolean",
"description": "X-example: true\nAppends header x-F5 Distributed Cloud-location = <RE-site-name> in responses. This configuration\nis ignored on CE sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_policies": {
"type": "array",
"description": "Advertise Policy allows you to define networks or sites where you want a VIP for this virtual host to be advertised.\nEach Policy rule can have different parameters, like TLS configuration, ports, optionally IP address to be used for VIP.\nIf advertise policy is not specified then no VIP is assigned for this virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.append_server_name": {
"type": "string",
"description": "Exclusive with [default_header pass_through server_name]\nSpecifies the value to be used for Server header if it is not already present.\nIf Server Header is already present it is not overwritten. It is just passed.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication": {
      "type": "object",
"description": "Authentication related information. This allows to configure the URL to redirect after the authentication\nAuthentication Object Reference, configuration of cookie params etc.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.auth_config": {
      "type": "array",
"description": "Reference to Authentication Config Object.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.authentication.cookie_params": {
      "type": "object",
"description": "Specifies different cookie related config parameters for authentication.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.redirect_dynamic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.redirect_url": {
      "type": "string",
"description": "Exclusive with [redirect_dynamic]\n\nuser can provide a URL for e.g https://abc.xyz.com where user gets redirected. This URL configured here\nmust match with the redirect URL configured with the OIDC provider.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.use_auth_object_config": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.buffer_policy": {
"type": "object",
"description": "Some upstream applications are not capable of handling streamed data. This config\nenables buffering the entire request before sending to upstream application. We can\nspecify the maximum buffer size and buffer interval with this config.\n\nBuffering can be enabled and disabled at VirtualHost and Route levels\nRoute level buffer configuration takes precedence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.buffer_policy.disabled": {
"type": "boolean",
"description": "Disable buffering for a particular route. This is useful when virtual-host\nhas buffering, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.buffer_policy.max_request_bytes": {
"type": "integer",
"description": "The maximum request size that the filter will buffer before the connection\nmanager will stop buffering and return a RequestEntityTooLarge (413) response.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 10485760,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.captcha_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coalescing_options": {
"type": "object",
"description": "TLS connection coalescing configuration (not compatible with mTLS)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coalescing_options.default_coalescing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coalescing_options.strict_coalescing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params": {
"type": "object",
"description": "Enables loadbalancer to compress dispatched data from an upstream service upon client request.\nThe content is compressed and then sent to the client with the appropriate headers if either response and request allow.\nOnly GZIP compression is supported.\n\nBy default compression will be skipped when:\n\nA request does NOT contain accept-encoding header.\nA request includes accept-encoding header, but it does not contain “gzip” or “*”.\nA request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress.\nA request whose accept-encoding header includes “identity”.\nA response contains a content-encoding header.\nA response contains a cache-control header whose value includes “no-transform”.\nA response contains a transfer-encoding header whose value includes “gzip”.\nA response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML.\nNeither content-length nor transfer-encoding headers are present in the response.\nResponse size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked).\n\nWhen compression is applied:\n\nThe content-length is removed from response headers.\nResponse headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header.\nThe “vary: accept-encoding” header is inserted on every response.\n\nGZIP Compression Level:\n\nA value which is optimal balance between speed of compression and amount of compression is chosen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params.content_length": {
"type": "integer",
"description": "Minimum response length, in bytes, which will trigger compression. The default value is 30.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.compression_params.content_type": {
"type": "array",
"description": "Set of strings that allows specifying which mime-types yield compression\nWhen this field is not defined, compression will be applied\nto the following mime-types:\n\"application/javascript\"\n\"application/JSON\",\n\"application/xhtml+XML\"\n\"image/svg+XML\"\n\"text/CSS\"\n\"text/HTML\"\n\"text/plain\"\n\"text/XML\"",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 50,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params.disable_on_etag_header": {
"type": "boolean",
"description": "If true, disables compression when the response contains an etag header. When it is false,\nweak etags will be preserved and the ones that require strong validation will be removed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params.remove_accept_encoding_header": {
"type": "boolean",
"description": "If true, removes accept-encoding from the request headers before dispatching it to the upstream\nso that responses do not GET compressed before reaching the filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connection_idle_timeout": {
"type": "integer",
"description": "The idle timeout for downstream connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 2 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy": {
"type": "object",
"description": "Cross-Origin Resource Sharing requests configuration specified at Virtual-host or\nRoute level. Route level configuration takes precedence.\n\nAn example of an Cross origin HTTP request\nGET /resources/public-data/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nReferrer: http://foo.example/examples/access-control/simplexsinvocation.html\nOrigin: http://foo.example\n\nHTTP/1.1 200 OK\nDate: Mon, 01 Dec 2008 00:23:53 GMT\nServer: Apache/2.0.61\nAccess-Control-Allow-Origin: *\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive\nTransfer-Encoding: chunked\nContent-Type: application/XML\n\nAn example for cross origin HTTP OPTIONS request with Access-Control-Request-* header\n\nOPTIONS /resources/POST-here/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nOrigin: http://foo.example\nAccess-Control-Request-Method: POST\nAccess-Control-Request-Headers: X-PINGOTHER, Content-Type\n\nHTTP/1.1 204 No Content\nDate: Mon, 01 Dec 2008 01:15:39 GMT\nServer: Apache/2.0.61 (Unix)\nAccess-Control-Allow-Origin: http://foo.example\nAccess-Control-Allow-Methods: POST, GET, OPTIONS\nAccess-Control-Allow-Headers: X-PINGOTHER, Content-Type\nAccess-Control-Max-Age: 86400\nVary: Accept-Encoding, Origin\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_credentials": {
      "type": "boolean",
"description": "Specifies whether the resource allows credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_headers": {
"type": "string",
"description": "Specifies the content for the access-control-allow-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_methods": {
"type": "string",
"description": "Specifies the content for the access-control-allow-methods header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin": {
"type": "array",
"description": "Specifies the origins that will be allowed to do CORS requests.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin_regex": {
"type": "array",
"description": "Specifies regex patterns that match allowed origins.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.disabled": {
"type": "boolean",
"description": "Disable the CorsPolicy for a particular route. This is useful when\nvirtual-host has CorsPolicy, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.expose_headers": {
"type": "string",
"description": "Specifies the content for the access-control-expose-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.maximum_age": {
"type": "integer",
"description": "Specifies the content for the access-control-max-age header in seconds.\nThis indicates the maximum number of seconds the results can be cached\nA value of -1 will disable caching.\nMaximum permitted value is 86400 seconds (24 hours)",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy": {
"type": "object",
"description": "To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host.\n\n1. The origin that caused the user agent to issue the request (source origin).\n2. The origin that the request is going to (target origin).\nWhen the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid.\nBecause CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.all_load_balancer_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.custom_domain_list": {
"type": "object",
"description": "List of domain names used for Host header matching.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_errors": {
"type": "object",
"description": "Map of integer error codes as keys and string values that can be used to provide custom\nHTTP pages for each error code.\nKey of the map can be either response code class or HTTP Error code. Response code classes\nfor key is configured as follows\n3 -- for 3xx response code class\n4 -- for 4xx response code class\n5 -- for 5xx response code class\nValue is the uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Access Denied\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Access Denied </p>\". Base64 encoded string for this HTML is \"PHA+IEFjY2VzcyBEZW5pZWQgPC9wPg==\"\nSpecific response code takes preference when both response code and response code class\nmatches for a request.\n\nThe configured custom errors are only applicable for loadbalancer generated errors.\nErrors returned from upstream server is propagated as is.\n\nF5XC provides default error pages for the errors generated by the loadbalancer. Content of\nthese pages are not editable. User has an option to disable the use of default F5XC error pages.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_header": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_default_error_pages": {
"type": "boolean",
"description": "An option to specify whether to disable using default F5XC error pages.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_dns_resolve": {
"type": "boolean",
"description": "Disable DNS resolution for domains specified in the virtual host\n\nWhen the virtual host is configured as Dynamive Resolve Proxy (DRP), disable DNS resolution\nfor domains configured. This configuration is suitable for HTTP CONNECT proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of Domains (host/authority header) that will be matched to this Virtual Host.\nWildcard hosts are supported in the suffix or prefix form\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.\n\nDomains are also used for SNI matching if the virtual host proxy type is TCP_PROXY_WITH_SNI/HTTPS_PROXY\nDomains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 33,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy": {
"type": "object",
"description": "In this mode of proxy, virtual host will resolve the destination endpoint dynamically.\n\nThe dynamic resolution is done using a predefined field in the request. This predefined\nfield depends on the ProxyType configured on the Virtual Host.\n\nFor HTTP traffic, i.e. With ProxyType as HTTP_PROXY or HTTPS_PROXY, virtual host will use the\n\"HOST\" HTTP header from the request and perform DNS resolution to select destination endpoint.\n\nFor TCP traffic with SNI, (If the ProxyType is TCP_PROXY_WITH_SNI), virtual host will perform DNS\nresolution using the SNI.\n\nThe DNS resolution is performed in the virtual network specified in outside_network_type or\noutside_network\n\nIn both modes of operation(either using Host header or SNI), the DNS resolution could return\nmultiple addresses. First IPv4 address from such returned list is used as endpoint for the\nrequest. The DNS response is cached for 60s by default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy.resolution_network": {
"type": "array",
"description": "Reference to virtual network where the endpoint is resolved.\nReference is valid only when the network type is VIRTUAL_NETWORK_PER_SITE or\nVIRTUAL_NETWORK_GLOBAL. It is ignored for all other network types.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy.resolution_network_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
},
"spec.dynamic_reverse_proxy.resolve_endpoint_dynamically": {
"type": "boolean",
"description": "X-example : true\nIn this mode of proxy, virtual host will resolve the destination endpoint dynamically.\n\nThe dynamic resolution is done using a predefined field in the request. This predefined\nfield depends on the ProxyType configured on the Virtual Host.\n\nFor HTTP traffic, i.e. With ProxyType as HTTP_PROXY or HTTPS_PROXY, virtual host will use the\n\"HOST\" HTTP header from the request and perform DNS resolution to select destination endpoint.\n\nFor TCP traffic with SNI, (If the ProxyType is TCP_PROXY_WITH_SNI), virtual host will perform DNS\nresolution using the SNI.\n\nThe DNS resolution is performed in the virtual network specified in outside_network_type or\noutside_network\n\nIn both modes of operation(either using Host header or SNI), the DNS resolution could return\nmultiple addresses. First IPv4 address from such returned list is used as endpoint for the\nrequest. The DNS response is cached for 60s by default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options": {
"type": "object",
"description": "HTTP protocol configuration OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options.http_protocol_enable_v1_only": {
"type": "object",
"description": "HTTP/1.1 Protocol OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options.http_protocol_enable_v1_v2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options.http_protocol_enable_v2_only": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.idle_timeout": {
"type": "integer",
"description": "Idle timeout is the amount of time that the loadbalancer will allow a stream to exist with\nno upstream or downstream activity.\n\nIdle timeout and Proxy Type:\n\nHTTP_PROXY, HTTPS_PROXY:\nIdle timer is started when the first byte is received on the connection.\nEach time an encode/decode event for headers or data is processed for the stream,\nthe timer will be reset.\nIf the timeout fires, the stream is terminated with a 504 (Gateway Timeout) error code if\nno upstream response header has been received, otherwise a stream reset occurs.\nThe default idle timeout is 30 seconds\n\nTCP PROXY, TCP_PROXY_WITH_SNI, SMA_PROXY:\nThe idle timeout is defined as the period in which there are no bytes sent or received on\neither the upstream or downstream connection.\nThe default idle timeout is 1 hour.\n\nUDP PROXY:\nThe idle timeout for sessions. Idle timeout is defined as the period in which there are no\ndatagrams sent or received on the session.\nThe default if not specified is 1 minute.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.max_request_header_size": {
"type": "integer",
"description": "The maximum request header size in KiB for incoming connections.\n\nIf un-configured, the default max request headers allowed is 60 KiB.\n\nRequests that exceed this limit will receive a 431 response.\n\nThe max configurable limit is 96 KiB, based on current implementation constraints.\n\nNote:\na. This configuration parameter is applicable only for HTTP_PROXY and HTTPS_PROXY\nb. When multiple HTTP_PROXY virtual hosts share the same advertise policy, the effective\n\"maximum request header size\" for such virtual hosts is the highest value configured\non any of the virtual hosts.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 96,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\nSets the maximum number of requests a downstream client can send\nover a single connection to Envoy.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_authentication": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.non_default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pass_through": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy": {
"type": "string",
"description": "ProxyType tells the type of proxy to install for the virtual host.\n\nOnly the following combination of VirtualHosts within same AdvertisePolicy is permitted\n(None of them should have \"*\" in domains when used with other VirtualHosts in same AdvertisePolicy)\n1. Multiple TCP_PROXY_WITH_SNI and multiple HTTPS_PROXY\n2. Multiple HTTP_PROXY\n3. Multiple HTTPS_PROXY\n4. Multiple TCP_PROXY_WITH_SNI\n\nHTTPS_PROXY without TLS parameters is not permitted\nHTTP_PROXY/HTTPS_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY with empty domains is not permitted\nTCP_PROXY_WITH_SNI/SMA_PROXY should not have \"*\" in domains\n\n- HTTP_PROXY: HTTP_PROXY\n\nInstall HTTP proxy. HTTP Proxy is the default proxy installed.\n- TCP_PROXY: TCP_PROXY\n\nInstall TCP proxy\n- TCP_PROXY_WITH_SNI: TCP_PROXY_WITH_SNI\n\nInstall TCP proxy with SNI Routing\n- TLS_TCP_PROXY: TCP_PROXY\n\nInstall TCP proxy\n- TLS_TCP_PROXY_WITH_SNI: TCP_PROXY_WITH_SNI\n\nInstall TCP proxy with SNI Routing\n- HTTPS_PROXY: HTTPS_PROXY\n\nInstall HTTPS proxy\n- UDP_PROXY: UDP_PROXY\n\nInstall UDP proxy\n- SMA_PROXY: SMA_PROXY\n\nInstall Secret Management Access proxy\n- DNS_PROXY: DNS_PROXY\n\nInstall DNS proxy\n- ZTNA_PROXY: ZTNA_PROXY\n\nInstall ZTNA proxy.this is going to be deprecated with UZTNA_PROXY.\n- UZTNA_PROXY: UZTNA_PROXY\n\nInstall UZTNA proxy\n- TMM_HTTP_PROXY: TMM_HTTP_PROXY\n\nInstall TMM HTTP proxy for HTTP/1.1 and HTTP/2 traffic. Used by TMM proxy type.\n- TMM_HTTPS_PROXY: TMM_HTTPS_PROXY\n\nInstall TMM HTTPS proxy for HTTP/1.1 and HTTP/2 traffic. Used by TMM proxy type.\n- TMM_TCP_PROXY: TMM_TCP_PROXY\n\nInstall TMM TCP proxy for TCP traffic. Used by TMM proxy type.\n- TMM_UDP_PROXY: TMM_UDP_PROXY\n\nInstall TMM UDP proxy for UDP traffic. Used by TMM proxy type.\n- TMM_QUIC_PROXY: TMM_QUIC_PROXY\n\nInstall TMM QUIC proxy for HTTP/3 traffic. Used by TMM proxy type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limiter_allowed_prefixes": {
"type": "array",
"description": "References to ip_prefix_set objects.\nRequests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_cookies_to_add": {
"type": "array",
"description": "Cookies are key-value pairs to be added to HTTP request being routed towards upstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_cookies_to_remove": {
"type": "array",
"description": "List of keys of Cookies to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP request being routed towards upstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_cookies_to_add": {
"type": "array",
"description": "Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_cookies_to_remove": {
"type": "array",
"description": "List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP response being sent towards downstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP response being sent towards downstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy": {
"type": "object",
"description": "Retry policy configuration for route destination.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.back_off": {
"type": "object",
"description": "Specifies parameters that control retry back off.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.num_retries": {
"type": "integer",
"description": "Specifies the allowed number of retries. Defaults to 1.\nRetries can be done any number of times. An exponential back-off algorithm\nis used between each retry.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 8,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.per_try_timeout": {
"type": "integer",
"description": "Specifies a non-zero timeout per retry attempt. In milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.retriable_status_codes": {
"type": "array",
"description": "HTTP status codes that should trigger a retry in addition to those specified by retry_on.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.retry_condition": {
"type": "array",
"description": "Specifies the conditions under which retry takes place.\nRetries can be on different types of condition depending on application requirements.\nFor example, network failure, all 5xx response codes, idempotent 4xx response codes, etc\n\nThe possible values are\n\n\"5xx\" : Retry will be done if the upstream server responds with any 5xx response code,\nor does not respond at all (disconnect/reset/read timeout).\n\n\"gateway-error\" : Retry will be done only if the upstream server responds with 502, 503 or\n504 responses (Included in 5xx)\n\n\"connect-failure\" : Retry will be done if the request fails because of a connection failure to the\nupstream server (connect timeout, etc.). (Included in 5xx)\n\n\"refused-stream\" : Retry is done if the upstream server resets the stream with a REFUSED_STREAM\nerror code (Included in 5xx)\n\n\"retriable-4xx\" : Retry is done if the upstream server responds with a retriable 4xx response code.\nThe only response code in this category is HTTP CONFLICT (409)\n\n\"retriable-status-codes\" : Retry is done if the upstream server responds with any response code\nmatching one defined in retriable_status_codes field\n\n\"reset\" : Retry is done if the upstream server does not respond at all\n(disconnect/reset/read timeout.)",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 7,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "The list of routes that will be matched, in order, for incoming requests.\nThe first route that matches will be used. Currently route object is redundant in case of TCP proxy but required.\nFor TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts, the route object only specifies the cluster/weighted-cluster\nas route destination without any match condition. In other words, match condition in route object is ignored for\nTCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts. Routes used for TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY\nVirtualHosts cannot have DirectResponse or Redirect as actions.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "array",
"description": "References to sensitive_data_policy objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name": {
"type": "string",
"description": "Exclusive with [append_server_name default_header pass_through]\nSpecifies the value to be used for Server header inserted in responses.\nThis will overwrite existing values if any for Server Header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation": {
"type": "object",
"description": "\"Slow and low\" attacks tie up server resources, leaving none available for servicing\nrequests from actual users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.disable_request_timeout": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_headers_timeout": {
"type": "integer",
"description": "The amount of time the client has to send only the headers on the request stream before\nthe stream is cancelled. The default value is 10000 milliseconds. This setting\nprovides protection against Slowloris attacks.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_timeout": {
"type": "integer",
"description": "Exclusive with [disable_request_timeout]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 300000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params": {
"type": "object",
"description": "Certificate Parameters for authentication, TLS ciphers, and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.certificates": {
"type": "array",
"description": "Set of certificates.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tls_cert_params.cipher_suites": {
"type": "array",
"description": "The following list specifies the supported cipher suite\nTLS_AES_128_GCM_SHA256\nTLS_AES_256_GCM_SHA384\nTLS_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\nTLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\nTLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\nTLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\nTLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\nTLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\nTLS_RSA_WITH_AES_128_CBC_SHA\nTLS_RSA_WITH_AES_128_GCM_SHA256\nTLS_RSA_WITH_AES_256_CBC_SHA\nTLS_RSA_WITH_AES_256_GCM_SHA384\n\nIf not specified, the default list:\nTLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\nTLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\nwill be used.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.client_certificate_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.client_certificate_required": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.maximum_protocol_version": {
"type": "string",
"description": "TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TLS_AUTO"
},
"spec.tls_cert_params.minimum_protocol_version": {
"type": "string",
"description": "TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TLS_AUTO"
},
"spec.tls_cert_params.no_client_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.validation_params": {
"type": "object",
"description": "This includes URL for a trust store, whether SAN verification is required\nand list of Subject Alt Names for verification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.xfcc_header_elements": {
"type": "array",
"description": "X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections.\nIf none are defined, the header will not be added.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters": {
"type": "object",
"description": "TLS configuration for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_required": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.common_params": {
"type": "object",
"description": "Information of different aspects for TLS authentication related to ciphers,\ncertificates and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.no_client_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.xfcc_header_elements": {
"type": "array",
"description": "X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections.\nIf none are defined, the header will not be added.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification": {
"type": "array",
"description": "A reference to user_identification object.\nThe rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type": {
"type": "object",
"description": "WAF instance will be pointing to an app_firewall object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type.app_firewall": {
"type": "object",
"description": "A list of references to the app_firewall configuration objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type.disable_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type.inherit_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.authentication_choice": [
      "authentication",
      "no_authentication"
      ],
"spec.challenge_type": [
"captcha_challenge",
"js_challenge",
"no_challenge"
],
"spec.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.strict_sni_host_header_check_choice": [],
"spec.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.authentication.cookie_params_choice": [
      "cookie_params",
"use_auth_object_config"
      ],
"spec.authentication.redirect_url_choice": [
      "redirect_dynamic",
"redirect_url"
],
"spec.authentication.cookie_params.secret_choice": [
      "auth_hmac",
      "kms_key_hmac"
      ],
"spec.coalescing_options.coalescing_choice": [
"default_coalescing",
"strict_coalescing"
],
"spec.csrf_policy.allowed_domains": [
"all_load_balancer_domains",
"custom_domain_list",
"disabled"
],
"spec.http_protocol_options.http_protocol_choice": [
"http_protocol_enable_v1_only",
"http_protocol_enable_v1_v2",
"http_protocol_enable_v2_only"
],
"spec.slow_ddos_mitigation.request_timeout_choice": [
"disable_request_timeout",
"request_timeout"
],
"spec.tls_cert_params.client_certificate_verify_choice": [
"client_certificate_optional",
"client_certificate_required",
"no_client_certificate"
],
"spec.tls_cert_params.validation_params.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
],
"spec.tls_parameters.client_certificate_verify_choice": [
"client_certificate_optional",
"client_certificate_required",
"no_client_certificate"
],
"spec.waf_type.ref_type": [
"app_firewall",
"disable_waf",
"inherit_waf"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_virtual_host",
"description": "Replace Virtual Host.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/virtual_hosts/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a virtual_host",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.virtual_host.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/schemavirtual_hostReplaceSpecType"
}
],
"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 virtual_hostReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a given virtual host in a given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.add_location": {
"type": "boolean",
"description": "X-example: true\nAppends header x-F5 Distributed Cloud-location = <RE-site-name> in responses. This configuration\nis ignored on CE sites.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.advertise_policies": {
"type": "array",
"description": "Advertise Policy allows you to define networks or sites where you want a VIP for this virtual host to be advertised.\nEach Policy rule can have different parameters, like TLS configuration, ports, optionally IP address to be used for VIP.\nIf advertise policy is not specified then no VIP is assigned for this virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.append_server_name": {
"type": "string",
"description": "Exclusive with [default_header pass_through server_name]\nSpecifies the value to be used for Server header if it is not already present.\nIf Server Header is already present it is not overwritten. It is just passed.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication": {
      "type": "object",
"description": "Authentication related information. This allows to configure the URL to redirect after the authentication\nAuthentication Object Reference, configuration of cookie params etc.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.auth_config": {
      "type": "array",
"description": "Reference to Authentication Config Object.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.authentication.cookie_params": {
      "type": "object",
"description": "Specifies different cookie related config parameters for authentication.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.redirect_dynamic": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.redirect_url": {
      "type": "string",
"description": "Exclusive with [redirect_dynamic]\n\nuser can provide a URL for e.g https://abc.xyz.com where user gets redirected. This URL configured here\nmust match with the redirect URL configured with the OIDC provider.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.authentication.use_auth_object_config": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.buffer_policy": {
"type": "object",
"description": "Some upstream applications are not capable of handling streamed data. This config\nenables buffering the entire request before sending to upstream application. We can\nspecify the maximum buffer size and buffer interval with this config.\n\nBuffering can be enabled and disabled at VirtualHost and Route levels\nRoute level buffer configuration takes precedence.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.buffer_policy.disabled": {
"type": "boolean",
"description": "Disable buffering for a particular route. This is useful when virtual-host\nhas buffering, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.buffer_policy.max_request_bytes": {
"type": "integer",
"description": "The maximum request size that the filter will buffer before the connection\nmanager will stop buffering and return a RequestEntityTooLarge (413) response.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 10485760,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform captcha challenge\n\nCaptcha challenge will be based on Google Recaptcha.\n\nWith this feature enabled, only clients that pass the captcha challenge will be allowed to\ncomplete the HTTP request.\n\nWhen loadbalancer is configured to do Captcha Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have captcha challenge embedded in it.\nClient will be allowed to make the request only if the captcha challenge is successful.\nLoadbalancer will tag response header with a cookie to avoid Captcha challenge for subsequent requests.\n\nCAPTCHA is mainly used as a security check to ensure only human users can pass through.\nGenerally, computers or bots are not capable of solving a captcha.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.captcha_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.captcha_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coalescing_options": {
"type": "object",
"description": "TLS connection coalescing configuration (not compatible with mTLS)",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coalescing_options.default_coalescing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coalescing_options.strict_coalescing": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params": {
"type": "object",
"description": "Enables loadbalancer to compress dispatched data from an upstream service upon client request.\nThe content is compressed and then sent to the client with the appropriate headers if either response and request allow.\nOnly GZIP compression is supported.\n\nBy default compression will be skipped when:\n\nA request does NOT contain accept-encoding header.\nA request includes accept-encoding header, but it does not contain “gzip” or “*”.\nA request includes accept-encoding with “gzip” or “*” with the weight “q=0”. Note that the “gzip” will have a higher weight then “*”. For example, if accept-encoding is “gzip;q=0,*;q=1”, the filter will not compress. But if the header is set to “*;q=0,gzip;q=1”, the filter will compress.\nA request whose accept-encoding header includes “identity”.\nA response contains a content-encoding header.\nA response contains a cache-control header whose value includes “no-transform”.\nA response contains a transfer-encoding header whose value includes “gzip”.\nA response does not contain a content-type value that matches one of the selected mime-types, which default to application/javascript, application/JSON, application/xhtml+XML, image/svg+XML, text/CSS, text/HTML, text/plain, text/XML.\nNeither content-length nor transfer-encoding headers are present in the response.\nResponse size is smaller than 30 bytes (only applicable when transfer-encoding is not chunked).\n\nWhen compression is applied:\n\nThe content-length is removed from response headers.\nResponse headers contain “transfer-encoding: chunked” and do not contain “content-encoding” header.\nThe “vary: accept-encoding” header is inserted on every response.\n\nGZIP Compression Level:\n\nA value which is optimal balance between speed of compression and amount of compression is chosen.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params.content_length": {
"type": "integer",
"description": "Minimum response length, in bytes, which will trigger compression. The default value is 30.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 30,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.compression_params.content_type": {
"type": "array",
"description": "Set of strings that allows specifying which mime-types yield compression\nWhen this field is not defined, compression will be applied\nto the following mime-types:\n\"application/javascript\"\n\"application/JSON\",\n\"application/xhtml+XML\"\n\"image/svg+XML\"\n\"text/CSS\"\n\"text/HTML\"\n\"text/plain\"\n\"text/XML\"",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 50,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params.disable_on_etag_header": {
"type": "boolean",
"description": "If true, disables compression when the response contains an etag header. When it is false,\nweak etags will be preserved and the ones that require strong validation will be removed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.compression_params.remove_accept_encoding_header": {
"type": "boolean",
"description": "If true, removes accept-encoding from the request headers before dispatching it to the upstream\nso that responses do not GET compressed before reaching the filter.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.connection_idle_timeout": {
"type": "integer",
"description": "The idle timeout for downstream connections. The idle timeout is defined as the\nperiod in which there are no active requests. When the idle timeout is reached the connection\nwill be closed. Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.\nThis is specified in milliseconds. The default value is 2 minutes.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy": {
"type": "object",
"description": "Cross-Origin Resource Sharing requests configuration specified at Virtual-host or\nRoute level. Route level configuration takes precedence.\n\nAn example of an Cross origin HTTP request\nGET /resources/public-data/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nReferrer: http://foo.example/examples/access-control/simplexsinvocation.html\nOrigin: http://foo.example\n\nHTTP/1.1 200 OK\nDate: Mon, 01 Dec 2008 00:23:53 GMT\nServer: Apache/2.0.61\nAccess-Control-Allow-Origin: *\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive\nTransfer-Encoding: chunked\nContent-Type: application/XML\n\nAn example for cross origin HTTP OPTIONS request with Access-Control-Request-* header\n\nOPTIONS /resources/POST-here/ HTTP/1.1\nHost: bar.other\nUser-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre\nAccept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nConnection: keep-alive\nOrigin: http://foo.example\nAccess-Control-Request-Method: POST\nAccess-Control-Request-Headers: X-PINGOTHER, Content-Type\n\nHTTP/1.1 204 No Content\nDate: Mon, 01 Dec 2008 01:15:39 GMT\nServer: Apache/2.0.61 (Unix)\nAccess-Control-Allow-Origin: http://foo.example\nAccess-Control-Allow-Methods: POST, GET, OPTIONS\nAccess-Control-Allow-Headers: X-PINGOTHER, Content-Type\nAccess-Control-Max-Age: 86400\nVary: Accept-Encoding, Origin\nKeep-Alive: timeout=2, max=100\nConnection: Keep-Alive.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_credentials": {
      "type": "boolean",
"description": "Specifies whether the resource allows credentials.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_headers": {
"type": "string",
"description": "Specifies the content for the access-control-allow-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_methods": {
"type": "string",
"description": "Specifies the content for the access-control-allow-methods header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin": {
"type": "array",
"description": "Specifies the origins that will be allowed to do CORS requests.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.allow_origin_regex": {
"type": "array",
"description": "Specifies regex patterns that match allowed origins.\nAn origin is allowed if either allow_origin or allow_origin_regex match.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.disabled": {
"type": "boolean",
"description": "Disable the CorsPolicy for a particular route. This is useful when\nvirtual-host has CorsPolicy, but we need to disable it on a specific route.\nThe value of this field is ignored for virtual-host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.expose_headers": {
"type": "string",
"description": "Specifies the content for the access-control-expose-headers header.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.cors_policy.maximum_age": {
"type": "integer",
"description": "Specifies the content for the access-control-max-age header in seconds.\nThis indicates the maximum number of seconds the results can be cached\nA value of -1 will disable caching.\nMaximum permitted value is 86400 seconds (24 hours)",
      "constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": -1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy": {
"type": "object",
"description": "To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its destination.the policy relies on two pieces of information used in determining if a request originated from the same host.\n\n1. The origin that caused the user agent to issue the request (source origin).\n2. The origin that the request is going to (target origin).\nWhen the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid.\nBecause CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.).",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.all_load_balancer_domains": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.custom_domain_list": {
"type": "object",
"description": "List of domain names used for Host header matching.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.csrf_policy.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_errors": {
"type": "object",
"description": "Map of integer error codes as keys and string values that can be used to provide custom\nHTTP pages for each error code.\nKey of the map can be either response code class or HTTP Error code. Response code classes\nfor key is configured as follows\n3 -- for 3xx response code class\n4 -- for 4xx response code class\n5 -- for 5xx response code class\nValue is the uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Access Denied\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Access Denied </p>\". Base64 encoded string for this HTML is \"PHA+IEFjY2VzcyBEZW5pZWQgPC9wPg==\"\nSpecific response code takes preference when both response code and response code class\nmatches for a request.\n\nThe configured custom errors are only applicable for loadbalancer generated errors.\nErrors returned from upstream server is propagated as is.\n\nF5XC provides default error pages for the errors generated by the loadbalancer. Content of\nthese pages are not editable. User has an option to disable the use of default F5XC error pages.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_header": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_default_error_pages": {
"type": "boolean",
"description": "An option to specify whether to disable using default F5XC error pages.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_dns_resolve": {
"type": "boolean",
"description": "Disable DNS resolution for domains specified in the virtual host\n\nWhen the virtual host is configured as Dynamive Resolve Proxy (DRP), disable DNS resolution\nfor domains configured. This configuration is suitable for HTTP CONNECT proxy.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.domains": {
"type": "array",
"description": "A list of Domains (host/authority header) that will be matched to this Virtual Host.\nWildcard hosts are supported in the suffix or prefix form\n\nSupported Domains and search order:\n1. Exact Domain names: www.example.com.\n2. Domains starting with a Wildcard: *.example.com.\n\nNot supported Domains:\n- Just a Wildcard: *\n- A Wildcard and TLD with no root Domain: *.com.\n- A Wildcard not matching a whole DNS label.\nE.g. *.example.com and *.bar.example.com are valid Wildcards however *bar.example.com, *-bar.example.com, and bar*.example.com are all invalid.\n\nAdditional notes:\nA Wildcard will not match empty string.\nE.g. *.example.com will match bar.example.com and baz-bar.example.com but not .example.com.\nThe longest Wildcards match first.\nOnly a single virtual host in the entire route configuration can match on *.\nAlso a Domain must be unique across all virtual hosts within an advertise policy.\n\nDomains are also used for SNI matching if the virtual host proxy type is TCP_PROXY_WITH_SNI/HTTPS_PROXY\nDomains also indicate the list of names for which DNS resolution will be automatically resolved to IP addresses by the system.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 33,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy": {
"type": "object",
"description": "In this mode of proxy, virtual host will resolve the destination endpoint dynamically.\n\nThe dynamic resolution is done using a predefined field in the request. This predefined\nfield depends on the ProxyType configured on the Virtual Host.\n\nFor HTTP traffic, i.e. With ProxyType as HTTP_PROXY or HTTPS_PROXY, virtual host will use the\n\"HOST\" HTTP header from the request and perform DNS resolution to select destination endpoint.\n\nFor TCP traffic with SNI, (If the ProxyType is TCP_PROXY_WITH_SNI), virtual host will perform DNS\nresolution using the SNI.\n\nThe DNS resolution is performed in the virtual network specified in outside_network_type or\noutside_network\n\nIn both modes of operation(either using Host header or SNI), the DNS resolution could return\nmultiple addresses. First IPv4 address from such returned list is used as endpoint for the\nrequest. The DNS response is cached for 60s by default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy.connection_timeout": {
"type": "integer",
"description": "The timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy.resolution_network": {
"type": "array",
"description": "Reference to virtual network where the endpoint is resolved.\nReference is valid only when the network type is VIRTUAL_NETWORK_PER_SITE or\nVIRTUAL_NETWORK_GLOBAL. It is ignored for all other network types.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.dynamic_reverse_proxy.resolution_network_type": {
"type": "string",
"description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIRTUAL_NETWORK_SITE_LOCAL"
},
"spec.dynamic_reverse_proxy.resolve_endpoint_dynamically": {
"type": "boolean",
"description": "X-example : true\nIn this mode of proxy, virtual host will resolve the destination endpoint dynamically.\n\nThe dynamic resolution is done using a predefined field in the request. This predefined\nfield depends on the ProxyType configured on the Virtual Host.\n\nFor HTTP traffic, i.e. With ProxyType as HTTP_PROXY or HTTPS_PROXY, virtual host will use the\n\"HOST\" HTTP header from the request and perform DNS resolution to select destination endpoint.\n\nFor TCP traffic with SNI, (If the ProxyType is TCP_PROXY_WITH_SNI), virtual host will perform DNS\nresolution using the SNI.\n\nThe DNS resolution is performed in the virtual network specified in outside_network_type or\noutside_network\n\nIn both modes of operation(either using Host header or SNI), the DNS resolution could return\nmultiple addresses. First IPv4 address from such returned list is used as endpoint for the\nrequest. The DNS response is cached for 60s by default.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_path_normalize": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options": {
"type": "object",
"description": "HTTP protocol configuration OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options.http_protocol_enable_v1_only": {
"type": "object",
"description": "HTTP/1.1 Protocol OPTIONS for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options.http_protocol_enable_v1_v2": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.http_protocol_options.http_protocol_enable_v2_only": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.idle_timeout": {
"type": "integer",
"description": "Idle timeout is the amount of time that the loadbalancer will allow a stream to exist with\nno upstream or downstream activity.\n\nIdle timeout and Proxy Type:\n\nHTTP_PROXY, HTTPS_PROXY:\nIdle timer is started when the first byte is received on the connection.\nEach time an encode/decode event for headers or data is processed for the stream,\nthe timer will be reset.\nIf the timeout fires, the stream is terminated with a 504 (Gateway Timeout) error code if\nno upstream response header has been received, otherwise a stream reset occurs.\nThe default idle timeout is 30 seconds\n\nTCP PROXY, TCP_PROXY_WITH_SNI, SMA_PROXY:\nThe idle timeout is defined as the period in which there are no bytes sent or received on\neither the upstream or downstream connection.\nThe default idle timeout is 1 hour.\n\nUDP PROXY:\nThe idle timeout for sessions. Idle timeout is defined as the period in which there are no\ndatagrams sent or received on the session.\nThe default if not specified is 1 minute.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge": {
"type": "object",
"description": "Enables loadbalancer to perform client browser compatibility test by redirecting to a page\nwith Javascript.\n\nWith this feature enabled, only clients that are capable of executing Javascript(mostly browsers)\nwill be allowed to complete the HTTP request.\n\nWhen loadbalancer is configured to do Javascript Challenge, it will redirect the browser to an\nHTML page on every new HTTP request. This HTML page will have Javascript embedded in it.\nLoadbalancer chooses a set of random numbers for every new client and sends these numbers along with an\nencrypted answer with the request such that it embed these numbers as input in the Javascript.\nJavascript will run on the requester browser and perform a complex Math operation.\nScript will submit the answer to loadbalancer. Loadbalancer will validate the answer by comparing the calculated\nanswer with the decrypted answer (which was encrypted when it was sent back as reply) and allow\nthe request to the upstream server only if the answer is correct.\nLoadbalancer will tag response header with a cookie to avoid Javascript challenge for subsequent requests.\n\nJavascript challenge serves following purposes\n * Validate that the request is coming via a browser that is capable for running Javascript\n * Force the browser to run a complex operation, f(X), that requires it to spend a large number\nof CPU cycles. This is to slow down a potential DoS attacker by making it difficult to launch\na large request flood without having to spend even larger CPU cost at their end.\n\nYou can enable either Javascript challenge or Captcha challenge on a virtual host.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.cookie_expiry": {
"type": "integer",
"description": "Cookie expiration period, in seconds.\nAn expired cookie causes the loadbalancer to issue a new challenge.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 86400,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.js_challenge.custom_page": {
"type": "string",
"description": "Custom message is of type uri_ref. Currently supported URL schemes is string:///.\nFor string:/// scheme, message needs to be encoded in Base64 format.\nYou can specify this message as base64 encoded plain text message e.g. \"Please Wait..\"\nor it can be HTML paragraph or a body string encoded as base64 string\nE.g. \"<p> Please Wait </p>\". Base64 encoded string for this HTML is \"PHA+IFBsZWFzZSBXYWl0IDwvcD4=\"",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 65536,
"format": "uri",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.js_challenge.js_script_delay": {
"type": "integer",
"description": "Delay introduced by Javascript, in milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1000,
"maximum": 60000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.max_request_header_size": {
"type": "integer",
"description": "The maximum request header size in KiB for incoming connections.\n\nIf un-configured, the default max request headers allowed is 60 KiB.\n\nRequests that exceed this limit will receive a 431 response.\n\nThe max configurable limit is 96 KiB, based on current implementation constraints.\n\nNote:\na. This configuration parameter is applicable only for HTTP_PROXY and HTTPS_PROXY\nb. When multiple HTTP_PROXY virtual hosts share the same advertise policy, the effective\n\"maximum request header size\" for such virtual hosts is the highest value configured\non any of the virtual hosts.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 96,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.max_requests_per_connection": {
"type": "integer",
"description": "Exclusive with [no_request_limit_per_connection]\nSets the maximum number of requests a downstream client can send\nover a single connection to Envoy.\nEnter a value >=1 to define the request limit per connection.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_authentication": {
      "type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_challenge": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_request_limit_per_connection": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.non_default_loadbalancer": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.pass_through": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.proxy": {
"type": "string",
"description": "ProxyType tells the type of proxy to install for the virtual host.\n\nOnly the following combination of VirtualHosts within same AdvertisePolicy is permitted\n(None of them should have \"*\" in domains when used with other VirtualHosts in same AdvertisePolicy)\n1. Multiple TCP_PROXY_WITH_SNI and multiple HTTPS_PROXY\n2. Multiple HTTP_PROXY\n3. Multiple HTTPS_PROXY\n4. Multiple TCP_PROXY_WITH_SNI\n\nHTTPS_PROXY without TLS parameters is not permitted\nHTTP_PROXY/HTTPS_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY with empty domains is not permitted\nTCP_PROXY_WITH_SNI/SMA_PROXY should not have \"*\" in domains\n\n- HTTP_PROXY: HTTP_PROXY\n\nInstall HTTP proxy. HTTP Proxy is the default proxy installed.\n- TCP_PROXY: TCP_PROXY\n\nInstall TCP proxy\n- TCP_PROXY_WITH_SNI: TCP_PROXY_WITH_SNI\n\nInstall TCP proxy with SNI Routing\n- TLS_TCP_PROXY: TCP_PROXY\n\nInstall TCP proxy\n- TLS_TCP_PROXY_WITH_SNI: TCP_PROXY_WITH_SNI\n\nInstall TCP proxy with SNI Routing\n- HTTPS_PROXY: HTTPS_PROXY\n\nInstall HTTPS proxy\n- UDP_PROXY: UDP_PROXY\n\nInstall UDP proxy\n- SMA_PROXY: SMA_PROXY\n\nInstall Secret Management Access proxy\n- DNS_PROXY: DNS_PROXY\n\nInstall DNS proxy\n- ZTNA_PROXY: ZTNA_PROXY\n\nInstall ZTNA proxy.this is going to be deprecated with UZTNA_PROXY.\n- UZTNA_PROXY: UZTNA_PROXY\n\nInstall UZTNA proxy\n- TMM_HTTP_PROXY: TMM_HTTP_PROXY\n\nInstall TMM HTTP proxy for HTTP/1.1 and HTTP/2 traffic. Used by TMM proxy type.\n- TMM_HTTPS_PROXY: TMM_HTTPS_PROXY\n\nInstall TMM HTTPS proxy for HTTP/1.1 and HTTP/2 traffic. Used by TMM proxy type.\n- TMM_TCP_PROXY: TMM_TCP_PROXY\n\nInstall TMM TCP proxy for TCP traffic. Used by TMM proxy type.\n- TMM_UDP_PROXY: TMM_UDP_PROXY\n\nInstall TMM UDP proxy for UDP traffic. Used by TMM proxy type.\n- TMM_QUIC_PROXY: TMM_QUIC_PROXY\n\nInstall TMM QUIC proxy for HTTP/3 traffic. Used by TMM proxy type.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.rate_limiter_allowed_prefixes": {
"type": "array",
"description": "References to ip_prefix_set objects.\nRequests from source IP addresses that are covered by one of the allowed IP Prefixes are not subjected to rate limiting.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 4,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_cookies_to_add": {
"type": "array",
"description": "Cookies are key-value pairs to be added to HTTP request being routed towards upstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_cookies_to_remove": {
"type": "array",
"description": "List of keys of Cookies to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP request being routed towards upstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.request_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP request being sent towards upstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_cookies_to_add": {
"type": "array",
"description": "Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream.\nCookies specified at this level are applied after cookies from matched Route are applied.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_cookies_to_remove": {
"type": "array",
"description": "List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_headers_to_add": {
"type": "array",
"description": "Headers are key-value pairs to be added to HTTP response being sent towards downstream.\nHeaders specified at this level are applied after headers from matched Route are applied.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.response_headers_to_remove": {
"type": "array",
"description": "List of keys of Headers to be removed from the HTTP response being sent towards downstream.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy": {
"type": "object",
"description": "Retry policy configuration for route destination.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.back_off": {
"type": "object",
"description": "Specifies parameters that control retry back off.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.num_retries": {
"type": "integer",
"description": "Specifies the allowed number of retries. Defaults to 1.\nRetries can be done any number of times. An exponential back-off algorithm\nis used between each retry.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 8,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.per_try_timeout": {
"type": "integer",
"description": "Specifies a non-zero timeout per retry attempt. In milliseconds.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 600000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.retriable_status_codes": {
"type": "array",
"description": "HTTP status codes that should trigger a retry in addition to those specified by retry_on.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.retry_policy.retry_condition": {
"type": "array",
"description": "Specifies the conditions under which retry takes place.\nRetries can be on different types of condition depending on application requirements.\nFor example, network failure, all 5xx response codes, idempotent 4xx response codes, etc\n\nThe possible values are\n\n\"5xx\" : Retry will be done if the upstream server responds with any 5xx response code,\nor does not respond at all (disconnect/reset/read timeout).\n\n\"gateway-error\" : Retry will be done only if the upstream server responds with 502, 503 or\n504 responses (Included in 5xx)\n\n\"connect-failure\" : Retry will be done if the request fails because of a connection failure to the\nupstream server (connect timeout, etc.). (Included in 5xx)\n\n\"refused-stream\" : Retry is done if the upstream server resets the stream with a REFUSED_STREAM\nerror code (Included in 5xx)\n\n\"retriable-4xx\" : Retry is done if the upstream server responds with a retriable 4xx response code.\nThe only response code in this category is HTTP CONFLICT (409)\n\n\"retriable-status-codes\" : Retry is done if the upstream server responds with any response code\nmatching one defined in retriable_status_codes field\n\n\"reset\" : Retry is done if the upstream server does not respond at all\n(disconnect/reset/read timeout.)",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 7,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.routes": {
"type": "array",
"description": "The list of routes that will be matched, in order, for incoming requests.\nThe first route that matches will be used. Currently route object is redundant in case of TCP proxy but required.\nFor TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts, the route object only specifies the cluster/weighted-cluster\nas route destination without any match condition. In other words, match condition in route object is ignored for\nTCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY VirtualHosts. Routes used for TCP_PROXY/TCP_PROXY_WITH_SNI/SMA_PROXY\nVirtualHosts cannot have DirectResponse or Redirect as actions.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sensitive_data_policy": {
"type": "array",
"description": "References to sensitive_data_policy objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.server_name": {
"type": "string",
"description": "Exclusive with [append_server_name default_header pass_through]\nSpecifies the value to be used for Server header inserted in responses.\nThis will overwrite existing values if any for Server Header.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 8096,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation": {
"type": "object",
"description": "\"Slow and low\" attacks tie up server resources, leaving none available for servicing\nrequests from actual users.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.disable_request_timeout": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_headers_timeout": {
"type": "integer",
"description": "The amount of time the client has to send only the headers on the request stream before\nthe stream is cancelled. The default value is 10000 milliseconds. This setting\nprovides protection against Slowloris attacks.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 30000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.slow_ddos_mitigation.request_timeout": {
"type": "integer",
"description": "Exclusive with [disable_request_timeout]",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 2000,
"maximum": 300000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params": {
"type": "object",
"description": "Certificate Parameters for authentication, TLS ciphers, and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.certificates": {
"type": "array",
"description": "Set of certificates.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.tls_cert_params.cipher_suites": {
"type": "array",
"description": "The following list specifies the supported cipher suite\nTLS_AES_128_GCM_SHA256\nTLS_AES_256_GCM_SHA384\nTLS_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\nTLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\nTLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\nTLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\nTLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\nTLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\nTLS_RSA_WITH_AES_128_CBC_SHA\nTLS_RSA_WITH_AES_128_GCM_SHA256\nTLS_RSA_WITH_AES_256_CBC_SHA\nTLS_RSA_WITH_AES_256_GCM_SHA384\n\nIf not specified, the default list:\nTLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\nTLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\nTLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\nTLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\nwill be used.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.client_certificate_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.client_certificate_required": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.maximum_protocol_version": {
"type": "string",
"description": "TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TLS_AUTO"
},
"spec.tls_cert_params.minimum_protocol_version": {
"type": "string",
"description": "TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "TLS_AUTO"
},
"spec.tls_cert_params.no_client_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.validation_params": {
"type": "object",
"description": "This includes URL for a trust store, whether SAN verification is required\nand list of Subject Alt Names for verification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_cert_params.xfcc_header_elements": {
"type": "array",
"description": "X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections.\nIf none are defined, the header will not be added.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters": {
"type": "object",
"description": "TLS configuration for downstream connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_optional": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.client_certificate_required": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.common_params": {
"type": "object",
"description": "Information of different aspects for TLS authentication related to ciphers,\ncertificates and trust store.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.no_client_certificate": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.tls_parameters.xfcc_header_elements": {
"type": "array",
"description": "X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections.\nIf none are defined, the header will not be added.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.user_identification": {
"type": "array",
"description": "A reference to user_identification object.\nThe rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type": {
"type": "object",
"description": "WAF instance will be pointing to an app_firewall object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type.app_firewall": {
"type": "object",
"description": "A list of references to the app_firewall configuration objects.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type.disable_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.waf_type.inherit_waf": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.authentication_choice": [
      "authentication",
      "no_authentication"
      ],
"spec.challenge_type": [
"captcha_challenge",
"js_challenge",
"no_challenge"
],
"spec.default_lb_choice": [
"default_loadbalancer",
"non_default_loadbalancer"
],
"spec.max_requests_per_connection_choice": [
"max_requests_per_connection",
"no_request_limit_per_connection"
],
"spec.path_normalize_choice": [
"disable_path_normalize",
"enable_path_normalize"
],
"spec.server_header_choice": [
"append_server_name",
"default_header",
"pass_through",
"server_name"
],
"spec.strict_sni_host_header_check_choice": [],
"spec.tls_certificates_choice": [
"tls_cert_params",
"tls_parameters"
],
"spec.authentication.cookie_params_choice": [
      "cookie_params",
"use_auth_object_config"
      ],
"spec.authentication.redirect_url_choice": [
      "redirect_dynamic",
"redirect_url"
],
"spec.authentication.cookie_params.secret_choice": [
      "auth_hmac",
      "kms_key_hmac"
      ],
"spec.coalescing_options.coalescing_choice": [
"default_coalescing",
"strict_coalescing"
],
"spec.csrf_policy.allowed_domains": [
"all_load_balancer_domains",
"custom_domain_list",
"disabled"
],
"spec.http_protocol_options.http_protocol_choice": [
"http_protocol_enable_v1_only",
"http_protocol_enable_v1_v2",
"http_protocol_enable_v2_only"
],
"spec.slow_ddos_mitigation.request_timeout_choice": [
"disable_request_timeout",
"request_timeout"
],
"spec.tls_cert_params.client_certificate_verify_choice": [
"client_certificate_optional",
"client_certificate_required",
"no_client_certificate"
],
"spec.tls_cert_params.validation_params.trusted_ca_choice": [
"trusted_ca",
"trusted_ca_url"
],
"spec.tls_parameters.client_certificate_verify_choice": [
"client_certificate_optional",
"client_certificate_required",
"no_client_certificate"
],
"spec.waf_type.ref_type": [
"app_firewall",
"disable_waf",
"inherit_waf"
]
}
},
{
"name": "list_virtual_hosts",
"description": "List Virtual Host.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_hosts",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_virtual_host",
"description": "DELETE Virtual Host.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/virtual_hosts/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a virtual_host",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.virtual_host.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
}
},
{
"name": "get_virtual_host",
"description": "GET Virtual Host.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_hosts/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"virtual-k8ss": {
"name": "virtual-k8ss",
"displayName": "Virtual K8Ss",
"operations": [
{
"name": "create_virtual_k8",
"description": "Create Virtual Kubernetes.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/virtual_k8ss",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of virtual_k8s",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.virtual_k8s.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/virtual_k8sCreateSpecType"
}
],
"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 virtual_k8sCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_k8sCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_k8sCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create virtual_k8s will create the object in the storage backend for namespace metadata.namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_flavor_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_flavor_ref.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.default_flavor_ref.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_flavor_ref.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.isolated": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vsite_refs": {
"type": "array",
"description": "Reference to virtual-sites\nDefault virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object\nannotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the\nKubernetes API resource object.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.service_isolation_choice": [
"disabled",
"isolated"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_virtual_k8",
"description": "Replace Virtual Kubernetes.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/virtual_k8ss/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a virtual_k8s",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.virtual_k8s.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/virtual_k8sReplaceSpecType"
}
],
"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 virtual_k8sReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_k8sReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_k8sReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_flavor_ref": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_flavor_ref.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.default_flavor_ref.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_flavor_ref.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.isolated": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vsite_refs": {
"type": "array",
"description": "Reference to virtual-sites\nDefault virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object\nannotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the\nKubernetes API resource object.",
      "constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 32,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.service_isolation_choice": [
"disabled",
"isolated"
]
}
},
{
"name": "list_virtual_k8ss",
"description": "List Virtual Kubernetes.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_k8ss",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_virtual_k8",
"description": "DELETE Virtual Kubernetes.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/virtual_k8ss/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a virtual_k8s",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.virtual_k8s.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_k8sDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_k8sDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
}
},
{
"name": "get_virtual_k8",
"description": "GET Virtual Kubernetes.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_k8ss/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"virtual-networks": {
"name": "virtual-networks",
"displayName": "Virtual Networks",
"operations": [
{
"name": "create_virtual_network",
"description": "Create Virtual Network.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/virtual_networks",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of virtual_network",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.virtual_network.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/virtual_networkCreateSpecType"
}
],
"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 virtual_networkCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_networkCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_networkCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create virtual network in given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.static_routes": {
"type": "array",
"description": "List of static routes on the virtual network.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 165,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.network_choice": [
"global_network",
"site_local_inside_network",
"site_local_network"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_virtual_network",
"description": "Replace Virtual Network.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/virtual_networks/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a virtual_network",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.virtual_network.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/virtual_networkReplaceSpecType"
}
],
"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 virtual_networkReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_networkReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_networkReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace given virtual network in given namespace.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_inside_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_local_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.static_routes": {
"type": "array",
"description": "List of static routes on the virtual network.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 165,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.network_choice": [
"global_network",
"site_local_inside_network",
"site_local_network"
]
}
},
{
"name": "list_virtual_networks",
"description": "List Virtual Network.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_networks",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_virtual_network",
"description": "DELETE Virtual Network.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/virtual_networks/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a virtual_network",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.virtual_network.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_networkDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_networkDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "network"
}
},
{
"name": "get_virtual_network",
"description": "GET Virtual Network.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_networks/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"virtual-sites": {
"name": "virtual-sites",
"displayName": "Virtual Sites",
"operations": [
{
"name": "create_virtual_site",
"description": "Create Virtual Site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/virtual_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of virtual_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.virtual_site.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/schemavirtual_siteCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Label-based site selector for grouping RE and CE sites — used as advertise_where target for HTTP LBs",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.site_type",
"spec.site_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-virtual-site\n  namespace: default\nspec:\n  site_type: REGIONAL_EDGE\n  site_selector:\n    expressions:\n      - \"ves.io/siteName=any\"\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-vsite\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"site_type\": \"REGIONAL_EDGE\",\n    \"site_selector\": {\"expressions\": [\"ves.io/region=iad\"]}\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual_infrastructure"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-vsite",
"namespace": "default"
},
"spec": {
"site_type": "REGIONAL_EDGE",
"site_selector": {
"expressions": [
"ves.io/region=iad"
]
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.site_type",
"spec.site_selector"
],
"description": "Label-based site selector for grouping RE and CE sites — used as advertise_where target for HTTP LBs"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a virtual site object in given namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.site_selector": {
"type": "object",
"description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax> ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction> ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion> ::= <inclusion> | <exclusion>\n<exclusion> ::= \"notin\"\n<inclusion> ::= \"in\"\n<value-set> ::= \"(\" <values> \")\"\n<values> ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.site_selector.expressions": {
"type": "array",
"description": "Expressions contains the Kubernetes style label expression for selections.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.site_type": {
"type": "string",
"description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "INVALID"
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_virtual_site",
"description": "Replace Virtual Site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/virtual_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a virtual_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.virtual_site.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemavirtual_siteReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Label-based site selector for grouping RE and CE sites — used as advertise_where target for HTTP LBs",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.site_type",
"spec.site_selector"
],
"mutually_exclusive_groups": [],
"example_yaml": "metadata:\n  name: example-virtual-site\n  namespace: default\nspec:\n  site_type: REGIONAL_EDGE\n  site_selector:\n    expressions:\n      - \"ves.io/siteName=any\"\n",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example-vsite\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"site_type\": \"REGIONAL_EDGE\",\n    \"site_selector\": {\"expressions\": [\"ves.io/region=iad\"]}\n  }\n}\n"
},
"x-f5xc-cli-domain": "virtual_infrastructure"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-vsite",
"namespace": "default"
},
"spec": {
"site_type": "REGIONAL_EDGE",
"site_selector": {
"expressions": [
"ves.io/region=iad"
]
}
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.site_type",
"spec.site_selector"
],
"description": "Label-based site selector for grouping RE and CE sites — used as advertise_where target for HTTP LBs"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a given virtual site object in a given namespace.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_virtual_sites",
"description": "List Virtual Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_virtual_site",
"description": "DELETE Virtual Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/virtual_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a virtual_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.virtual_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual_infrastructure"
}
},
{
"name": "get_virtual_site",
"description": "GET Virtual Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/virtual_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"vk8s-audit-logs": {
"name": "vk8s-audit-logs",
"displayName": "Vk8S Audit Logs",
"operations": [
{
"name": "create_vk8s_audit_log",
"description": "VK8s Audit Log Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/vk8s_audit_logs",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch Virtual K8s audit logs.",
"title": "VK8SAuditLogRequest",
"x-displayname": "VK8s Audit Log Request.",
"x-ves-proto-message": "ves.io.schema.log.VK8SAuditLogRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch vK8s audit logs for a given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch vK8s audit logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all vK8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={objectref.resource=\"deployments\"}",
"x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request to fetch Virtual K8s audit logs.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logVK8SAuditLogRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logVK8SAuditLogRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logVK8SAuditLogRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch vK8s audit logs for a given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all vK8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch audit logs whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"vk8s-events": {
"name": "vk8s-events",
"displayName": "Vk8S Events",
"operations": [
{
"name": "create_vk8s_event",
"description": "VK8s Events Query.",
"method": "POST",
"path": "/api/data/namespaces/{namespace}/vk8s_events",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "Request to fetch Virtual K8s events.",
"title": "vK8s Events Request",
"x-displayname": "VK8s Events Request.",
"x-ves-proto-message": "ves.io.schema.log.VK8SEventsRequest",
"properties": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "title": "aggregations",
"x-displayname": "Aggregations.",
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.",
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"title": "end time",
"x-displayname": "End Time",
"x-ves-example": "2019-09-24T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-24T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
"x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of vK8s events returned in the response\nOptional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"title": "limit",
"format": "int32",
"x-displayname": "Limit",
"x-ves-example": "100",
"x-f5xc-example": "100",
"x-f5xc-description-short": "Limits the number of vK8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending...",
"x-f5xc-description-medium": "Limits the number of vK8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
"x-f5xc-constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch vK8s events for the given namespace.",
"title": "namespace",
"x-displayname": "Namespace",
"x-ves-example": "Value",
"x-f5xc-example": "value",
"x-f5xc-description-short": "Fetch vK8s events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\nsite - Name of the site\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the vK8s events for the given tenant and namespace are returned.",
"title": "query",
"x-displayname": "Query",
"x-ves-example": "Query={involvedobject.kind=\"Pod\"}",
"x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"",
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of events (or all events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of events until there are no more events left to return. The number of events in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "scroll",
"format": "boolean",
"x-displayname": "Scroll",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Scroll is used to retrieve large number of events (or all events) that matches the query.",
"x-f5xc-description-medium": "Scroll is used to retrieve large number of events (or all events) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of events until there are no more events left to return. The number of events in each batch is...",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "title": "search after",
"format": "boolean",
"x-displayname": "Search After.",
"x-ves-example": "True",
"x-f5xc-example": "true",
"x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.",
"x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"allOf": [
{
"$ref": "#/components/schemas/schemaSortOrder"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values": {
"allOf": [
{
"$ref": "#/components/schemas/logSearchAfterSortValues"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"title": "start time",
"x-displayname": "Start Time.",
"x-ves-example": "2019-09-23T12:30:11.733Z.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-example": "2019-09-23T12:30:11.733Z",
"x-validation-rules": {
"ves.io.schema.rules.string.query_time": "true"
},
"x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
"x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for logVK8SEventsRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for logVK8SEventsRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "statistics"
},
"responseSchema": {
"type": "object",
"properties": {
"aggs": {
"type": "object"
},
"logs": {
"type": "array"
},
"scroll_id": {
"type": "string"
},
"total_hits": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for logVK8SEventsRequest"
},
"fieldMetadata": {
"aggs": {
"type": "object",
"description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"end_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"limit": {
"type": "integer",
"description": "Limits the number of vK8s events returned in the response\nOptional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.",
"constraints": {
"constraintType": "number",
"category": "policy",
"minimum": 1,
"maximum": 1000000,
"multipleOf": 1,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Fetch vK8s events for the given namespace.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"query": {
"type": "string",
"description": "Query is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>\"<value>\"\n<field_name> := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\nsite - Name of the site\n<value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the vK8s events for the given tenant and namespace are returned.",
"constraints": {
"constraintType": "string",
"category": "content",
"maxLength": 1024,
"minLength": 0,
"metadata": {
"source": "inferred",
"confidence": 0.75,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"scroll": {
"type": "boolean",
"description": "Scroll is used to retrieve large number of events (or all events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of events until there are no more events left to return. The number of events in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"search_after": {
"type": "boolean",
"description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort": {
"type": "string",
"description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "DESCENDING"
},
"sort_values": {
"type": "object",
"description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_doc_id": {
"type": "string",
"description": "This is a unique UUID generated by elastic search.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"sort_values.last_timestamp": {
"type": "number",
"description": "Configuration parameter for last timestamp",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"start_time": {
"type": "string",
"description": "Fetch vK8s events whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "aggs",
"type": "object",
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request."
      },
{
"field": "last_sort_values",
"type": "object",
"description": ""
},
{
"field": "logs",
"type": "array",
"description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response."
},
{
"field": "scroll_id",
"type": "string",
"description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse."
},
{
"field": "total_hits",
"type": "string",
"description": "Total number of log messages that matched the query."
}
]
}
]
},
	"voltstack-sites": {
"name": "voltstack-sites",
"displayName": "Voltstack Sites",
"operations": [
{
"name": "create_voltstack_site",
"description": "Create App Stack site.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/voltstack_sites",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of voltstack_site",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.voltstack_site.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/viewsvoltstack_siteCreateSpecType"
}
],
"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 voltstack_siteCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltstack_siteCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for voltstack_siteCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the App Stack site specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.bond_device_list": {
"type": "object",
"description": "List of bond devices for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list.bond_devices": {
"type": "array",
"description": "List of bond devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.bgp_peer_address": {
"type": "string",
"description": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured\nto fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.bgp_router_id": {
"type": "string",
"description": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to\nfetch BGP router ID from site object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_interface_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_sli_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.interface_list": {
"type": "object",
"description": "Configure network interfaces for this App Stack site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.outside_nameserver": {
"type": "string",
"description": "Optional DNS server V4 IP to be used for name resolution in local network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.outside_vip": {
"type": "string",
"description": "Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.site_to_site_tunnel_ip": {
"type": "string",
"description": "Exclusive with [sm_connection_public_ip sm_connection_pvt_ip]\nSite Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for\ncreating IPsec between two sites which are part of the site mesh group.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sli_config": {
"type": "object",
"description": "Site local inside network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.slo_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.custom_storage_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.default_storage_class": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.no_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.no_storage_device": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.no_storage_interfaces": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.storage_device_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.storage_interface_list": {
"type": "object",
"description": "Configure storage interfaces for this App Stack site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_network_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sriov_interface": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_storage_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_vm": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu": {
"type": "object",
"description": "Licensing configuration for NVIDIA vGPU.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.feature_type": {
"type": "string",
"description": "Set feature to be enabled\n\nOperate with a degraded vGPU performance\nEnable NVIDIA vGPU\nEnable NVIDIA RTX Virtual Workstation\nEnable NVIDIA Virtual Compute Server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNLICENSED"
},
"spec.enable_vgpu.server_address": {
"type": "string",
"description": "Set License Server Address.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.server_port": {
"type": "integer",
"description": "Set License Server port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_vm": {
"type": "object",
"description": "VMs support configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.k8s_cluster.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane": {
"type": "object",
"description": "Enable local control plane for L3VPN, SRV6, EVPN etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane.bgp_config": {
"type": "object",
"description": "BGP configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane.inside_vn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane.outside_vn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.master_node_configuration": {
"type": "array",
"description": "Configuration of master nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_bond_devices": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_local_control_plane": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces": {
"type": "object",
"description": "List of all custom SR-IOV interfaces configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces.sriov_interface": {
"type": "array",
"description": "Use custom SR-IOV interfaces Configuration.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.volterra_certified_hw": {
"type": "string",
"description": "Name for generic server certified hardware to form this App Stack site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.worker_nodes": {
"type": "array",
"description": "Names of worker nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"blocked_services",
"default_blocked_services"
],
"spec.bond_choice": [
"bond_device_list",
"no_bond_devices"
],
"spec.gpu_choice": [
"disable_gpu",
"enable_gpu",
"enable_vgpu"
],
"spec.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.local_control_plane_choice": [
"local_control_plane",
"no_local_control_plane"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.network_cfg_choice": [
"custom_network_config",
"default_network_config"
],
"spec.sriov_interface_choice": [
"default_sriov_interface",
"sriov_interfaces"
],
"spec.storage_cfg_choice": [
"custom_storage_config",
"default_storage_config"
],
"spec.usb_policy_choice": [
"allow_all_usb",
"deny_all_usb",
"usb_policy"
],
"spec.vm_choice": [
"disable_vm",
"enable_vm"
],
"spec.custom_network_config.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.custom_network_config.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.custom_network_config.interface_choice": [
"default_interface_config",
"interface_list"
],
"spec.custom_network_config.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.custom_network_config.site_mesh_group_choice": [
"site_to_site_tunnel_ip",
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.custom_network_config.sli_choice": [
"default_sli_config",
"sli_config"
],
"spec.custom_network_config.slo_choice": [
"default_config",
"slo_config"
],
"spec.custom_network_config.sli_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.sli_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.custom_network_config.slo_config.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.custom_network_config.slo_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.slo_config.static_v6_route_choice": [
"no_static_v6_routes",
"static_v6_routes"
],
"spec.custom_storage_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_storage_config.storage_class_choice": [
"default_storage_class",
"storage_class_list"
],
"spec.custom_storage_config.storage_device_choice": [
"no_storage_device",
"storage_device_list"
],
"spec.custom_storage_config.storage_interface_choice": [
"no_storage_interfaces",
"storage_interface_list"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.local_control_plane.network_choice": [
"inside_vn",
"outside_vn"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_voltstack_site",
"description": "Replace App Stack site.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/voltstack_sites/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a voltstack_site",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.voltstack_site.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/viewsvoltstack_siteReplaceSpecType"
}
],
"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 voltstack_siteReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltstack_siteReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for voltstack_siteReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of the App Stack site replace specification.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.address": {
"type": "string",
"description": "Site's geographical address that can be used to determine its latitude and longitude.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.allow_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services": {
"type": "object",
"description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.blocked_services.blocked_service": {
"type": "array",
"description": "Blocking or denial configuration",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"wireName": "blocked_sevice"
},
"spec.bond_device_list": {
"type": "object",
"description": "List of bond devices for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.bond_device_list.bond_devices": {
"type": "array",
"description": "List of bond devices.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.coordinates": {
"type": "object",
"description": "Coordinates of the site which provides the site physical location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.latitude": {
"type": "number",
"description": "Latitude of the site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.coordinates.longitude": {
"type": "number",
"description": "Longitude of site location.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns": {
"type": "object",
"description": "Custom DNS is the configured for specify CE site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.inside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in inside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_dns.outside_nameserver": {
"type": "string",
"description": "Optional DNS server IP to be used for name resolution in outside network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_enhanced_firewall_policies": {
"type": "object",
"description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_forward_proxy_policies": {
"type": "object",
"description": "Ordered List of Forward Proxy Policies active.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.active_network_policies": {
"type": "object",
"description": "List of firewall policy views.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.bgp_peer_address": {
"type": "string",
"description": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured\nto fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.bgp_router_id": {
"type": "string",
"description": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to\nfetch BGP router ID from site object.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_interface_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.default_sli_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.forward_proxy_allow_all": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.global_network_list": {
"type": "object",
"description": "List of global network connections.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.interface_list": {
"type": "object",
"description": "Configure network interfaces for this App Stack site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_forward_proxy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_global_network": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.no_network_policy": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.outside_nameserver": {
"type": "string",
"description": "Optional DNS server V4 IP to be used for name resolution in local network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.outside_vip": {
"type": "string",
"description": "Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ipv4",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.site_to_site_tunnel_ip": {
"type": "string",
"description": "Exclusive with [sm_connection_public_ip sm_connection_pvt_ip]\nSite Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for\ncreating IPsec between two sites which are part of the site mesh group.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"format": "ip",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sli_config": {
"type": "object",
"description": "Site local inside network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.slo_config": {
"type": "object",
"description": "Site local network configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_public_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.sm_connection_pvt_ip": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.tunnel_dead_timeout": {
"type": "integer",
"description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 0,
"maximum": 180000,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_network_config.vip_vrrp_mode": {
"type": "string",
"description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "VIP_VRRP_INVALID"
},
"spec.custom_storage_config": {
"type": "object",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.default_storage_class": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.no_static_routes": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.no_storage_device": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.no_storage_interfaces": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.static_routes": {
"type": "object",
"description": "List of static routes.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.storage_class_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.storage_device_list": {
"type": "object",
"description": "Add additional custom storage classes in Kubernetes for this fleet.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.custom_storage_config.storage_interface_list": {
"type": "object",
"description": "Configure storage interfaces for this App Stack site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_blocked_services": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_network_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_sriov_interface": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.default_storage_config": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.deny_all_usb": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.disable_vm": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_gpu": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu": {
"type": "object",
"description": "Licensing configuration for NVIDIA vGPU.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.feature_type": {
"type": "string",
"description": "Set feature to be enabled\n\nOperate with a degraded vGPU performance\nEnable NVIDIA vGPU\nEnable NVIDIA RTX Virtual Workstation\nEnable NVIDIA Virtual Compute Server.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "UNLICENSED"
},
"spec.enable_vgpu.server_address": {
"type": "string",
"description": "Set License Server Address.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.enable_vgpu.server_port": {
"type": "integer",
"description": "Set License Server port number.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"minimum": 1,
"maximum": 65535,
"deterministic": true,
"metadata": {
"source": "api-probed",
      "confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.enable_vm": {
"type": "object",
"description": "VMs support configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.k8s_cluster.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.k8s_cluster.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain": {
"type": "object",
"description": "Specify how worker nodes within a site will be upgraded.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.disable_upgrade_drain": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.kubernetes_upgrade_drain.enable_upgrade_drain": {
"type": "object",
"description": "Specify batch upgrade settings for worker nodes within a site.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane": {
"type": "object",
"description": "Enable local control plane for L3VPN, SRV6, EVPN etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane.bgp_config": {
"type": "object",
"description": "BGP configuration parameters.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane.inside_vn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.local_control_plane.outside_vn": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.log_receiver.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.logs_streaming_disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.master_node_configuration": {
"type": "array",
"description": "Configuration of master nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 3,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.no_bond_devices": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_k8s_cluster": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.no_local_control_plane": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode": {
"type": "object",
"description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.enable_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.offline_survivability_mode.no_offline_survivability_mode": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os": {
"type": "object",
"description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.default_os_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.os.operating_system_version": {
"type": "string",
"description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces": {
"type": "object",
"description": "List of all custom SR-IOV interfaces configuration.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sriov_interfaces.sriov_interface": {
"type": "array",
"description": "Use custom SR-IOV interfaces Configuration.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw": {
"type": "object",
"description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.default_sw_version": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.sw.volterra_software_version": {
"type": "string",
"description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 20,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy": {
"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.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 128,
"byteLength": {
"max": 128,
"min": 1
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true,
"byteLength": {
"max": 64
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.usb_policy.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.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 64,
"byteLength": {
"max": 64
},
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.volterra_certified_hw": {
"type": "string",
"description": "Name for generic server certified hardware to form this App Stack site.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 1024,
"format": "dns-label",
"pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.worker_nodes": {
"type": "array",
"description": "Names of worker nodes.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 128,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.blocked_services_choice": [
"blocked_services",
"default_blocked_services"
],
"spec.bond_choice": [
"bond_device_list",
"no_bond_devices"
],
"spec.gpu_choice": [
"disable_gpu",
"enable_gpu",
"enable_vgpu"
],
"spec.k8s_cluster_choice": [
"k8s_cluster",
"no_k8s_cluster"
],
"spec.local_control_plane_choice": [
"local_control_plane",
"no_local_control_plane"
],
"spec.logs_receiver_choice": [
"log_receiver",
"logs_streaming_disabled"
],
"spec.network_cfg_choice": [
"custom_network_config",
"default_network_config"
],
"spec.sriov_interface_choice": [
"default_sriov_interface",
"sriov_interfaces"
],
"spec.storage_cfg_choice": [
"custom_storage_config",
"default_storage_config"
],
"spec.usb_policy_choice": [
"allow_all_usb",
"deny_all_usb",
"usb_policy"
],
"spec.vm_choice": [
"disable_vm",
"enable_vm"
],
"spec.custom_network_config.forward_proxy_choice": [
"active_forward_proxy_policies",
"forward_proxy_allow_all",
"no_forward_proxy"
],
"spec.custom_network_config.global_network_choice": [
"global_network_list",
"no_global_network"
],
"spec.custom_network_config.interface_choice": [
"default_interface_config",
"interface_list"
],
"spec.custom_network_config.network_policy_choice": [
"active_enhanced_firewall_policies",
"active_network_policies",
"no_network_policy"
],
"spec.custom_network_config.site_mesh_group_choice": [
"site_to_site_tunnel_ip",
"sm_connection_public_ip",
"sm_connection_pvt_ip"
],
"spec.custom_network_config.sli_choice": [
"default_sli_config",
"sli_config"
],
"spec.custom_network_config.slo_choice": [
"default_config",
"slo_config"
],
"spec.custom_network_config.sli_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.sli_config.static_v6_route_choice": [
"no_v6_static_routes",
"static_v6_routes"
],
"spec.custom_network_config.slo_config.dc_cluster_group_choice": [
"dc_cluster_group",
"no_dc_cluster_group"
],
"spec.custom_network_config.slo_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_network_config.slo_config.static_v6_route_choice": [
"no_static_v6_routes",
"static_v6_routes"
],
"spec.custom_storage_config.static_route_choice": [
"no_static_routes",
"static_routes"
],
"spec.custom_storage_config.storage_class_choice": [
"default_storage_class",
"storage_class_list"
],
"spec.custom_storage_config.storage_device_choice": [
"no_storage_device",
"storage_device_list"
],
"spec.custom_storage_config.storage_interface_choice": [
"no_storage_interfaces",
"storage_interface_list"
],
"spec.kubernetes_upgrade_drain.kubernetes_upgrade_drain_enable_choice": [
"disable_upgrade_drain",
"enable_upgrade_drain"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_choice": [
"drain_max_unavailable_node_count"
],
"spec.kubernetes_upgrade_drain.enable_upgrade_drain.vega_upgrade_mode_toggle_choice": [
"disable_vega_upgrade_mode",
"enable_vega_upgrade_mode"
],
"spec.local_control_plane.network_choice": [
"inside_vn",
"outside_vn"
],
"spec.offline_survivability_mode.offline_survivability_mode_choice": [
"enable_offline_survivability_mode",
"no_offline_survivability_mode"
],
"spec.os.operating_system_version_choice": [
"default_os_version",
"operating_system_version"
],
"spec.sw.volterra_sw_version_choice": [
"default_sw_version",
"volterra_software_version"
]
}
},
{
"name": "list_voltstack_sites",
"description": "List Configure App Stack Site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/voltstack_sites",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_voltstack_site",
"description": "DELETE Configure App Stack Site.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/voltstack_sites/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a voltstack_site",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.voltstack_site.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for voltstack_siteDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for voltstack_siteDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "sites"
}
},
{
"name": "get_voltstack_site",
"description": "GET App Stack site.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/voltstack_sites/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"vulnerabilities": {
"name": "vulnerabilities",
"displayName": "Vulnerabilities",
"operations": [
{
"name": "create_vulnerabilitie",
"description": "GET Vulnerabilities for Virtual Host.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/vulnerabilities",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request model for GetVulnerabilitiesReq API.",
      "title": "GetVulnerabilitiesReq",
"x-displayname": "GET Vulnerabilities Request.",
"x-ves-oneof-field-context": "[\"api_endpoint\"]",
      "x-ves-proto-message": "ves.io.schema.virtual_host.GetVulnerabilitiesReq",
"properties": {
"api_endpoint": {
      "allOf": [
{
"$ref": "#/components/schemas/schemavirtual_hostAPIEndpoint"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domains": {
"type": "array",
"description": "List of domains for which vulnerabilities should be returned.\nOptional filter by domains. If absent, vulnerabilities for all domains are considered.",
"title": "List of Domain",
"maxItems": 5,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"x-displayname": "List of Domain.",
"x-ves-example": "www.example.com.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.items.string.max_len": "256",
"ves.io.schema.rules.repeated.items.string.min_len": "1",
"ves.io.schema.rules.repeated.items.string.vh_domain_or_ip": "true",
"ves.io.schema.rules.repeated.max_items": "5",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "www.example.com",
"x-validation-rules": {
"ves.io.schema.rules.repeated.items.string.max_len": "256",
"ves.io.schema.rules.repeated.items.string.min_len": "1",
"ves.io.schema.rules.repeated.items.string.vh_domain_or_ip": "true",
"ves.io.schema.rules.repeated.max_items": "5",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "List of domains for which vulnerabilities should be returned. Optional filter by domains.",
"x-f5xc-description-medium": "List of domains for which vulnerabilities should be returned. Optional filter by domains. If absent, vulnerabilities for all domains are considered.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request model for GetVulnerabilitiesReq API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostGetVulnerabilitiesReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostGetVulnerabilitiesReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object",
"properties": {
"vulnerabilities": {
"type": "array"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for virtual_hostGetVulnerabilitiesReq"
},
"fieldMetadata": {
"api_endpoint": {
      "type": "object",
"description": "APIEndpoint Object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_endpoint.collapsed_url": {
      "type": "string",
"description": "Requested API endPoint for API URL.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_endpoint.method": {
      "type": "string",
"description": "Requested API endPoint for method.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domains": {
"type": "array",
"description": "List of domains for which vulnerabilities should be returned.\nOptional filter by domains. If absent, vulnerabilities for all domains are considered.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 5,
"minItems": 1,
"uniqueItems": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"context": [
"api_endpoint"
      ]
},
"responseSummary": [
{
"field": "vulnerabilities",
"type": "array",
"description": "List of vulnerabilities found in context."
}
]
}
]
},
	"vulnerability-update-state": {
"name": "vulnerability-update-state",
"displayName": "Vulnerability Update State",
"operations": [
{
"name": "create_vulnerability_update_state",
"description": "Update Vulnerabilities for Virtual Host.",
"method": "POST",
"path": "/api/ml/data/namespaces/{namespace}/virtual_hosts/{name}/vulnerability/update_state",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request model for UpdateVulnerabilitiesStateReq API.",
      "title": "UpdateVulnerabilitiesStateReq",
"x-displayname": "Update Vulnerability State.",
"x-ves-oneof-field-context": "[\"api_endpoint\"]",
      "x-ves-proto-message": "ves.io.schema.virtual_host.UpdateVulnerabilitiesStateReq",
"properties": {
"api_endpoint": {
      "allOf": [
{
"$ref": "#/components/schemas/schemavirtual_hostAPIEndpoint"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domain": {
"type": "string",
"description": "Domain for which vulnerability state should be updated.",
"title": "Domain",
"x-displayname": "Domain",
"x-ves-example": "www.example.com.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "www.example.com",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-description-short": "Domain for which vulnerability state should be updated.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"format": "hostname",
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"title": "Virtual Host Name",
"x-displayname": "Virtual Host Name.",
"x-ves-example": "Blogging-app-vhost.",
"x-f5xc-example": "blogging-app-vhost",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Blogging-app.",
"x-f5xc-example": "blogging-app",
"x-f5xc-description-short": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"vuln_id": {
"type": "string",
"description": "Vulnerability ID.",
"title": "vulnerability_id",
"x-displayname": "Vulnerability ID.",
"x-ves-required": "true",
"x-ves-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-example": "HTTP_SUPPORTED_AND_HSTS_NOT_SET",
"x-validation-rules": {
"ves.io.schema.rules.message.required": "true"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
},
"x-field-mutability": "read-only"
},
"vuln_state": {
"allOf": [
{
"$ref": "#/components/schemas/virtual_hostVulnStatus"
}
],
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "Request model for UpdateVulnerabilitiesStateReq API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for virtual_hostUpdateVulnerabilitiesStateReq",
"required_fields": [
"domain",
"vuln_id"
],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for virtual_hostUpdateVulnerabilitiesStateReq\nmetadata:\n  name: example\n  namespace: default\nspec:\n  domain: value\n  vuln_id: value",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"domain\": \"value\",\n    \"vuln_id\": \"value\"\n  }\n}"
},
"x-f5xc-cli-domain": "other"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {
"domain": "value",
"vuln_id": "value"
}
},
"requiredFields": [
"domain",
"vuln_id"
],
"description": "Minimum configuration for virtual_hostUpdateVulnerabilitiesStateReq"
},
"fieldMetadata": {
"api_endpoint": {
      "type": "object",
"description": "APIEndpoint Object.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_endpoint.collapsed_url": {
      "type": "string",
"description": "Requested API endPoint for API URL.",
      "constraints": {
"constraintType": "string",
"category": "discovery",
"minLength": 1,
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_endpoint.method": {
      "type": "string",
"description": "Requested API endPoint for method.",
      "constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domain": {
"type": "string",
"description": "Domain for which vulnerability state should be updated.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Virtual Host name for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the virtual host for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"vuln_id": {
"type": "string",
"description": "Vulnerability ID.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"vuln_state": {
"type": "string",
"description": "Status of vulnerability found\n\nVulnerability has no status\nVulnerability has open status and it will be under Active tab\nVulnerability has ignore status\nThe vulnerability Ignored manually and it will be under Archived tab\nThe next Discovery process should ignore the vulnerability.\nVulnerability has resolution status\nThe vulnerability resolved manually and it will be under Archived tab\nThe next Discovery process should validate the resolution and reopen (Move to Active and mark as Open) if not resolved.\nVulnerability has under review status and it will be under Active tab\nThe vulnerability under security or development team responsibility.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"default": "STATUS_NONE"
}
},
"oneOfVariants": {
"context": [
"api_endpoint"
      ]
}
}
]
},
	"waf-exclusion-policys": {
"name": "waf-exclusion-policys",
"displayName": "Waf Exclusion Policys",
"operations": [
{
"name": "create_waf_exclusion_policy",
"description": "Create WAF Exclusion Policy.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/waf_exclusion_policys",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of waf_exclusion_policy",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.waf_exclusion_policy.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/schemawaf_exclusion_policyCreateSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"x-f5xc-minimum-configuration": {
"description": "WAF exclusion policy for tuning false positives in app_firewall rules",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.waf_exclusion_rules"
],
"mutually_exclusive_groups": [
{
"name": "domain_choice",
"fields": [
"spec.waf_exclusion_rules[].any_domain",
"spec.waf_exclusion_rules[].exact_value",
"spec.waf_exclusion_rules[].suffix_value"
],
"reason": "Choose domain matching type per rule"
},
{
"name": "path_choice",
"fields": [
"spec.waf_exclusion_rules[].any_path",
"spec.waf_exclusion_rules[].path_prefix",
"spec.waf_exclusion_rules[].path_regex"
],
"reason": "Choose path matching type per rule"
}
],
"example_yaml": "apiVersion: v1\nkind: waf_exclusion_policy\nmetadata:\n  name: example-waf-exclusion\n  namespace: default\nspec:\n  waf_exclusion_rules:\n    - metadata:\n        name: exclude-health\n      exact_path: \"/health\"\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-waf-exclusion\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"waf_exclusion_rules\": [\n      {\"metadata\": {\"name\": \"exclude-health\"}}\n    ]\n  }\n}\n"
},
"x-f5xc-cli-domain": "waf"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-waf-exclusion",
"namespace": "default"
},
"spec": {
"waf_exclusion_rules": [
{
"metadata": {
"name": "exclude-health"
}
}
]
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.waf_exclusion_rules"
],
"description": "WAF exclusion policy for tuning false positives in app_firewall rules"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a WAF exclusion policy.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.waf_exclusion_rules": {
"type": "array",
"description": "An ordered list of rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_waf_exclusion_policy",
"description": "Replace WAF Exclusion Policy.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/waf_exclusion_policys/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a waf_exclusion_policy",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.waf_exclusion_policy.ReplaceRequest",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/schemaObjectReplaceMetaType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/schemawaf_exclusion_policyReplaceSpecType"
}
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"resource_version": {
"type": "string",
"x-f5xc-concurrency-token": {
      "server_assigned": true,
"echo_on_operations": [
"replace"
]
}
}
},
"x-f5xc-minimum-configuration": {
"description": "WAF exclusion policy for tuning false positives in app_firewall rules",
"required_fields": [
"metadata.name",
"metadata.namespace",
"spec.waf_exclusion_rules"
],
"mutually_exclusive_groups": [
{
"name": "domain_choice",
"fields": [
"spec.waf_exclusion_rules[].any_domain",
"spec.waf_exclusion_rules[].exact_value",
"spec.waf_exclusion_rules[].suffix_value"
],
"reason": "Choose domain matching type per rule"
},
{
"name": "path_choice",
"fields": [
"spec.waf_exclusion_rules[].any_path",
"spec.waf_exclusion_rules[].path_prefix",
"spec.waf_exclusion_rules[].path_regex"
],
"reason": "Choose path matching type per rule"
}
],
"example_yaml": "apiVersion: v1\nkind: waf_exclusion_policy\nmetadata:\n  name: example-waf-exclusion\n  namespace: default\nspec:\n  waf_exclusion_rules:\n    - metadata:\n        name: exclude-health\n      exact_path: \"/health\"\n",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example-waf-exclusion\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {\n    \"waf_exclusion_rules\": [\n      {\"metadata\": {\"name\": \"exclude-health\"}}\n    ]\n  }\n}\n"
},
"x-f5xc-cli-domain": "waf"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example-waf-exclusion",
"namespace": "default"
},
"spec": {
"waf_exclusion_rules": [
{
"metadata": {
"name": "exclude-health"
}
}
]
}
},
"requiredFields": [
"metadata.name",
"metadata.namespace",
"spec.waf_exclusion_rules"
],
"description": "WAF exclusion policy for tuning false positives in app_firewall rules"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace an existing WAF exclusion policy.",
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.waf_exclusion_rules": {
"type": "array",
"description": "An ordered list of rules.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
}
}
},
{
"name": "list_waf_exclusion_policys",
"description": "List WAF Exclusion Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/waf_exclusion_policys",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_waf_exclusion_policy",
"description": "DELETE WAF Exclusion Policy.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/waf_exclusion_policys/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a waf_exclusion_policy",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.waf_exclusion_policy.DeleteRequest",
"properties": {
"fail_if_referred": {
"type": "boolean",
"description": "Fail the DELETE operation if this object is being referred by other objects.",
"title": "fail_if_referred",
"format": "boolean",
"x-displayname": "Fail-If-Referred.",
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "Name of the configuration object.",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Name",
"x-f5xc-example": "name",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for waf_exclusion_policyDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for waf_exclusion_policyDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "waf"
}
},
{
"name": "get_waf_exclusion_policy",
"description": "GET WAF Exclusion Policy.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/waf_exclusion_policys/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"waf-exclusion-suggestion": {
"name": "waf-exclusion-suggestion",
"displayName": "Waf Exclusion Suggestion",
"operations": [
{
"name": "create_waf_exclusion_suggestion",
"description": "Suggest WAF Exclusion Rule.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/waf_exclusion/suggestion",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "GET suggested service policy rule to set up WAF rule exclusion for a given WAF security event.",
"title": "GetSuggestedWAFExclusionRuleReq",
"x-displayname": "GET Suggested WAF Exclusion Request.",
"x-ves-proto-message": "ves.io.schema.app_security.GetSuggestedWAFExclusionRuleReq",
"properties": {
"api_endpoint": {
      "allOf": [
{
"$ref": "#/components/schemas/app_securityApiEndpoint"
      }
],
"x-f5xc-example": "{\"key\": \"value\"}",
      "x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domain": {
"type": "string",
"description": "Domain",
"title": "Domain",
"maxLength": 256,
"x-displayname": "Domain",
"x-ves-example": "juiceshop.com.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.hostname": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "juiceshop.com",
"x-validation-rules": {
"ves.io.schema.rules.string.hostname": "true",
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"format": "hostname",
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"exclude_bot_names": {
"type": "array",
"description": "Bot name contexts to be excluded for this request.",
"title": "Exclude Bot Name Contexts",
"maxItems": 64,
"items": {
"$ref": "#/components/schemas/policyBotNameContext"
},
"x-displayname": "Exclude Bot Name Contexts.",
"x-ves-example": "Hydra, Nikto.",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "64",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "Hydra, Nikto",
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "64",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "Bot name contexts to be excluded for this request.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"exclude_signature_contexts": {
"type": "array",
"description": "App Firewall signature contexts to be excluded for this request.",
"title": "Exclude Signature Contexts",
"maxItems": 1024,
"items": {
"$ref": "#/components/schemas/policyAppFirewallSignatureContext"
},
"x-displayname": "Exclude App Firewall Signature Contexts.",
"x-ves-example": "[[10000001, 30000000]]",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "1024",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "[[10000001, 30000000]]",
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "1024",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "App Firewall signature contexts to be excluded for this request.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1024,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"exclude_violation_contexts": {
"type": "array",
"description": "App Firewall violation contexts to be excluded for this request.",
"title": "Exclude Violation Contexts",
"maxItems": 64,
"items": {
"$ref": "#/components/schemas/policyAppFirewallViolationContext"
},
"x-displayname": "Exclude App Firewall Violation Contexts.",
"x-ves-example": "[[VIOL_MANDATORY_HEADER, VIOL_REQUEST_MAX_LENGTH]]",
"x-ves-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "64",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-example": "[[VIOL_MANDATORY_HEADER, VIOL_REQUEST_MAX_LENGTH]]",
"x-validation-rules": {
"ves.io.schema.rules.repeated.max_items": "64",
"ves.io.schema.rules.repeated.unique": "true"
},
"x-f5xc-description-short": "App Firewall violation contexts to be excluded for this request.",
"x-f5xc-constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this WAF exclusion will be applied.",
"title": "Name",
"x-displayname": "HTTP Load Balancer Name.",
"x-ves-example": "VES-I/O-frontend.",
"x-f5xc-example": "ves-io-frontend",
"x-f5xc-description-short": "HTTP load balancer for which this WAF exclusion will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "Shared",
"x-f5xc-example": "shared",
"x-f5xc-description-short": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"req_path": {
"type": "string",
"description": "Request URL path.",
"title": "Request Path",
"maxLength": 256,
"x-displayname": "Request Path.",
"x-ves-example": "/abcd/2452422c/xyz.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-example": "/abcd/2452422c/xyz",
"x-validation-rules": {
"ves.io.schema.rules.string.max_len": "256"
},
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"route_uuid": {
"type": "string",
"description": "Unique identifier for the request route.",
"title": "Route UUID",
"x-displayname": "Route UUID.",
"x-ves-example": "00000000-0000-4000-8000-25a697151bfa.",
"x-ves-validation-rules": {
"ves.io.schema.rules.string.pattern": "^$|^[a-fA-F0-9]{8}-([a-fA-F0-9]{4}-){3}[a-fA-F0-9]{12}$"
},
"x-f5xc-example": "00000000-0000-4000-8000-25a697151bfa",
"x-validation-rules": {
"ves.io.schema.rules.string.pattern": "^$|^[a-fA-F0-9]{8}-([a-fA-F0-9]{4}-){3}[a-fA-F0-9]{12}$"
},
"x-f5xc-description-short": "Unique identifier for the request route.",
"x-f5xc-constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^$|^[a-fA-F0-9]{8}-([a-fA-F0-9]{4}-){3}[a-fA-F0-9]{12}$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"x-f5xc-description-short": "GET suggested service policy rule to set up WAF rule exclusion for a given WAF security event.",
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for app_securityGetSuggestedWAFExclusionRuleReq",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for app_securityGetSuggestedWAFExclusionRuleReq\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "virtual"
},
"responseSchema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for app_securityGetSuggestedWAFExclusionRuleReq"
},
"fieldMetadata": {
"api_endpoint": {
      "type": "object",
"description": "API Endpoint identified by collapsed_url and method.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_endpoint.collapsed_url": {
      "type": "string",
"description": "Collapsed URL is the path with identified DYN components.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"api_endpoint.method": {
      "type": "string",
"description": "HTTP method.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"domain": {
"type": "string",
"description": "Domain",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"format": "hostname",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"exclude_bot_names": {
"type": "array",
"description": "Bot name contexts to be excluded for this request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"exclude_signature_contexts": {
"type": "array",
"description": "App Firewall signature contexts to be excluded for this request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 1024,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"exclude_violation_contexts": {
"type": "array",
"description": "App Firewall violation contexts to be excluded for this request.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 64,
"uniqueItems": true,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"name": {
"type": "string",
"description": "HTTP load balancer for which this WAF exclusion will be applied.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Namespace of the App type for current request.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"req_path": {
"type": "string",
"description": "Request URL path.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 256,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"route_uuid": {
"type": "string",
"description": "Unique identifier for the request route.",
"constraints": {
"constraintType": "string",
"category": "discovery",
"maxLength": 1024,
"pattern": "^$|^[a-fA-F0-9]{8}-([a-fA-F0-9]{4}-){3}[a-fA-F0-9]{12}$",
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "found_existing_rule",
"type": "object",
"description": ""
},
{
"field": "name",
"type": "string",
"description": "HTTP load balancer for which this WAF exclusion will be applied."
},
{
"field": "waf_exclusion_policy",
"type": "object",
"description": ""
},
{
"field": "waf_exclusion_rule",
"type": "object",
"description": ""
}
]
}
]
},
	"waf-threat-campaign": {
"name": "waf-threat-campaign",
"displayName": "Waf Threat Campaign",
"operations": [
{
"name": "get_waf_threat_campaign",
"description": "GET Threat Campaign by ID.",
"method": "GET",
"path": "/api/waf/threat_campaign/{id}",
      "dangerLevel": "low",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"attack_type": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"intent": {
"type": "string"
},
"last_update": {
"type": "string"
},
"malwares": {
"type": "array"
},
"name": {
"type": "string"
},
"references": {
"type": "array"
},
"risk": {
"type": "string"
},
"systems": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "attack_type",
"type": "string",
"description": "The Threat Campaign Attack Type."
},
{
"field": "description",
"type": "string",
"description": "The Threat Campaign Description."
},
{
"field": "id",
"type": "string",
"description": "The Threat Campaign ID."
},
{
"field": "intent",
"type": "string",
"description": "The Threat Campaign Intent."
},
{
"field": "last_update",
"type": "string",
"description": "The Threat Campaign last update time."
},
{
"field": "malwares",
"type": "array",
"description": "The Threat Campaign Malwares."
},
{
"field": "name",
"type": "string",
"description": "The Threat Campaign Name."
},
{
"field": "references",
"type": "array",
"description": "The Threat Campaign References."
},
{
"field": "risk",
"type": "string",
"description": "The Threat Campaign Risk."
},
{
"field": "systems",
"type": "array",
"description": "The Threat Campaign Systems."
}
]
}
]
},
	"waf-update": {
"name": "waf-update",
"displayName": "Waf Update",
"operations": [
{
"name": "create_waf_update",
"description": "Update Authorization Server.",
      "method": "POST",
"path": "/api/waf/namespaces/{namespace}/authorization_servers/{name}/update",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "Request message for UpdateAuthorizationServer API.",
      "title": "Update Authorization Server Request",
      "x-displayname": "Update Authorization Server Request.",
      "x-ves-proto-message": "ves.io.schema.authorization_server.UpdateAuthorizationServerRequest",
      "properties": {
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "name",
"x-displayname": "Name",
"x-ves-example": "Okta",
"x-f5xc-example": "okta",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"title": "Namespace",
"x-displayname": "Namespace",
"x-ves-example": "System",
"x-f5xc-example": "system",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-description-short": "Request message for UpdateAuthorizationServer API.",
      "x-f5xc-minimum-configuration": {
"description": "Minimum configuration for authorization_serverUpdateAuthorizationServerRequest",
      "required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for authorization_serverUpdateAuthorizationServerRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
      "example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "tenant_and_identity"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for authorization_serverUpdateAuthorizationServerRequest"
      },
"fieldMetadata": {
"name": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"namespace": {
"type": "string",
"description": "Human-readable name for the resource",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
}
]
},
	"was-user-token": {
"name": "was-user-token",
      "displayName": "Was User Token",
      "operations": [
{
"name": "list_was_user_token",
      "description": "GET Web App Scanning Service User Token.",
      "method": "GET",
"path": "/api/config/namespaces/system/was/user_token",
      "dangerLevel": "low",
"parameters": [],
"responseSchema": {
"type": "object",
"properties": {
"redirect_url": {
"type": "string"
},
"token": {
      "type": "string"
},
"user_id": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "redirect_url",
"type": "string",
"description": "The Web App Scanning Service URL to be redirected by F5 Distributed Cloud Console."
},
{
"field": "token",
      "type": "string",
"description": "The token to connect to Web App Scanning Service."
      },
{
"field": "user_id",
"type": "string",
"description": "The User ID of Web App Scanning Service."
}
]
}
]
},
	"workload-flavors": {
"name": "workload-flavors",
"displayName": "Workload Flavors",
"operations": [
{
"name": "create_workload_flavor",
"description": "Create Workload Flavor.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/workload_flavors",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of workload_flavor",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.workload_flavor.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/workload_flavorCreateSpecType"
}
],
"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 workload_flavorCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workload_flavorCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for workload_flavorCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Create a workload_flavor.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ephemeral_storage": {
"type": "string",
"description": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "uint64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.memory": {
"type": "string",
"description": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "uint64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vcpus": {
"type": "number",
"description": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_workload_flavor",
"description": "Replace Flavor.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/workload_flavors/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a workload_flavor",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.workload_flavor.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/workload_flavorReplaceSpecType"
}
],
"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 workload_flavorReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workload_flavorReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for workload_flavorReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Replace a K8s workload_flavor.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.ephemeral_storage": {
"type": "string",
"description": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "uint64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.memory": {
"type": "string",
"description": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
"constraints": {
"constraintType": "string",
"category": "general",
"maxLength": 1024,
"format": "uint64",
"metadata": {
"source": "inferred",
"confidence": 0.85,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.vcpus": {
"type": "number",
"description": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
}
},
{
"name": "list_workload_flavors",
"description": "List Workload Flavor.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/workload_flavors",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_workload_flavor",
"description": "DELETE Workload Flavor.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/workload_flavors/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a workload_flavor",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.workload_flavor.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for workload_flavorDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workload_flavorDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
}
},
{
"name": "get_workload_flavor",
"description": "GET Workload Flavor.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/workload_flavors/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
	"workloads": {
"name": "workloads",
"displayName": "Workloads",
"operations": [
{
"name": "create_workload",
"description": "Create Workload.",
"method": "POST",
"path": "/api/config/namespaces/{namespace}/workloads",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Create' RPC.",
"title": "CreateRequest is used to create an instance of workload",
"x-displayname": "Create Request.",
"x-ves-proto-message": "ves.io.schema.views.workload.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/viewsworkloadCreateSpecType"
}
],
"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 workloadCreateRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workloadCreateRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object",
"properties": {}
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for workloadCreateRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of Workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job": {
"type": "object",
"description": "Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks\nlike report generation, billing, parallel data processing, ETL processing, etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.containers": {
"type": "array",
"description": "Containers to use for the job.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.job.deploy_options": {
"type": "object",
"description": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.num_replicas": {
"type": "integer",
"description": "Number of replicas of the batch job to spawn per site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.volumes": {
"type": "array",
"description": "Volumes for the job.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service": {
"type": "object",
"description": "Service does not maintain per replica state, however it can be configured to use persistent\nstorage that is shared amongst all the replicas. Replicas of a service are fungible and do\nnot have a stable network identity or storage. Common examples of services are web servers,\napplication servers, traditional SQL databases, etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.advertise_options": {
"type": "object",
"description": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.containers": {
"type": "array",
"description": "Containers to use for service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.service.deploy_options": {
"type": "object",
"description": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.num_replicas": {
"type": "integer",
"description": "Exclusive with [scale_to_zero]\nNumber of replicas of service to spawn per site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 5,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.scale_to_zero": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.volumes": {
"type": "array",
"description": "Volumes for the service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service": {
"type": "object",
"description": "SimpleService is a service having one container and one replica that is\ndeployed on all Regional Edges and advertised on Internet via HTTP loadbalancer\non default VIP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.container": {
"type": "object",
"description": "ContainerType configures the container information.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.enabled": {
"type": "object",
"description": "Persistent storage volume configuration for the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.scale_to_zero": {
"type": "boolean",
"description": "Scale down replicas of the service to zero.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.simple_advertise": {
"type": "object",
"description": "Advertise OPTIONS for Simple Service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service": {
"type": "object",
"description": "StatefulService maintains per replica state and each replica has its own persistent storage. Each replica\nhas a unique network identity and stable storage. Stateful service are used for distributed stateful\napplications like cassandra, mongodb, redis, etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.advertise_options": {
"type": "object",
"description": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.containers": {
"type": "array",
"description": "Containers to use for service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.stateful_service.deploy_options": {
"type": "object",
"description": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.num_replicas": {
"type": "integer",
"description": "Exclusive with [scale_to_zero]\nNumber of replicas of service to spawn per site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 5,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.persistent_volumes": {
"type": "array",
"description": "Persistent storage configuration for the service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.stateful_service.scale_to_zero": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.volumes": {
"type": "array",
"description": "Ephemeral volumes for the service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.workload_choice": [
"job",
"service",
"simple_service",
"stateful_service"
],
"spec.job.deploy_options.deploy_choice": [
"all_res",
"default_virtual_sites",
"deploy_ce_sites",
"deploy_ce_virtual_sites",
"deploy_re_sites",
"deploy_re_virtual_sites"
],
"spec.service.scaling_choice": [
"num_replicas",
"scale_to_zero"
],
"spec.service.advertise_options.advertise_choice": [
"advertise_custom",
"advertise_in_cluster",
"advertise_on_public",
"do_not_advertise"
],
"spec.service.deploy_options.deploy_choice": [
"all_res",
"default_virtual_sites",
"deploy_ce_sites",
"deploy_ce_virtual_sites",
"deploy_re_sites",
"deploy_re_virtual_sites"
],
"spec.simple_service.advertise_choice": [
"do_not_advertise",
"simple_advertise"
],
"spec.simple_service.persistence_choice": [
"disabled",
"enabled"
],
"spec.simple_service.container.flavor_choice": [
"custom_flavor",
"default_flavor",
"flavor"
],
"spec.stateful_service.scaling_choice": [
"num_replicas",
"scale_to_zero"
],
"spec.stateful_service.advertise_options.advertise_choice": [
"advertise_custom",
"advertise_in_cluster",
"advertise_on_public",
"do_not_advertise"
],
"spec.stateful_service.deploy_options.deploy_choice": [
"all_res",
"default_virtual_sites",
"deploy_ce_sites",
"deploy_ce_virtual_sites",
"deploy_re_sites",
"deploy_re_virtual_sites"
]
},
"responseSummary": [
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "system_metadata",
"type": "object",
"description": ""
}
]
},
{
"name": "replace_workload",
"description": "Replace Workload.",
"method": "PUT",
"path": "/api/config/namespaces/{namespace}/workloads/{name}",
      "dangerLevel": "medium",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'Replace' RPC.",
"title": "ReplaceRequest is used to replace contents of a workload",
"x-displayname": "Replace Request.",
"x-ves-proto-message": "ves.io.schema.views.workload.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/viewsworkloadReplaceSpecType"
}
],
"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 workloadReplaceRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workloadReplaceRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
},
"responseSchema": {
"type": "object"
},
"minimumPayload": {
"json": {
"metadata": {
"name": "example",
"namespace": "default"
},
"spec": {}
},
"requiredFields": [],
"description": "Minimum configuration for workloadReplaceRequest"
},
"fieldMetadata": {
"metadata": {
"type": "object",
"description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.description": {
"type": "string",
"description": "Human readable description for the object.",
"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-08-20T09:12:47+00:00"
},
"byteLength": {
"max": 1200
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.disable": {
"type": "boolean",
"description": "A value of true will administratively disable the object.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"metadata.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.",
      "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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"metadata.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 \"\"",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec": {
"type": "object",
"description": "Shape of Workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job": {
"type": "object",
"description": "Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks\nlike report generation, billing, parallel data processing, ETL processing, etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.containers": {
"type": "array",
"description": "Containers to use for the job.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.job.deploy_options": {
"type": "object",
"description": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.num_replicas": {
"type": "integer",
"description": "Number of replicas of the batch job to spawn per site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 5,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.job.volumes": {
"type": "array",
"description": "Volumes for the job.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service": {
"type": "object",
"description": "Service does not maintain per replica state, however it can be configured to use persistent\nstorage that is shared amongst all the replicas. Replicas of a service are fungible and do\nnot have a stable network identity or storage. Common examples of services are web servers,\napplication servers, traditional SQL databases, etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.advertise_options": {
"type": "object",
"description": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.containers": {
"type": "array",
"description": "Containers to use for service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.service.deploy_options": {
"type": "object",
"description": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.num_replicas": {
"type": "integer",
"description": "Exclusive with [scale_to_zero]\nNumber of replicas of service to spawn per site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 5,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.scale_to_zero": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.service.volumes": {
"type": "array",
"description": "Volumes for the service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service": {
"type": "object",
"description": "SimpleService is a service having one container and one replica that is\ndeployed on all Regional Edges and advertised on Internet via HTTP loadbalancer\non default VIP.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.container": {
"type": "object",
"description": "ContainerType configures the container information.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.disabled": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.do_not_advertise": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.enabled": {
"type": "object",
"description": "Persistent storage volume configuration for the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.scale_to_zero": {
"type": "boolean",
"description": "Scale down replicas of the service to zero.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.simple_service.simple_advertise": {
"type": "object",
"description": "Advertise OPTIONS for Simple Service.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service": {
"type": "object",
"description": "StatefulService maintains per replica state and each replica has its own persistent storage. Each replica\nhas a unique network identity and stable storage. Stateful service are used for distributed stateful\napplications like cassandra, mongodb, redis, etc.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.advertise_options": {
"type": "object",
"description": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.configuration": {
"type": "object",
"description": "Configuration parameters of the workload.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.containers": {
"type": "array",
"description": "Containers to use for service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.stateful_service.deploy_options": {
"type": "object",
"description": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.num_replicas": {
"type": "integer",
"description": "Exclusive with [scale_to_zero]\nNumber of replicas of service to spawn per site.",
"constraints": {
"constraintType": "number",
"category": "discovery",
"maximum": 5,
"minimum": 1,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.persistent_volumes": {
"type": "array",
"description": "Persistent storage configuration for the service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": true,
"create": true,
"update": false,
"read": false
}
},
"spec.stateful_service.scale_to_zero": {
"type": "object",
"description": "This can be used for messages where no values are needed.",
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
},
"spec.stateful_service.volumes": {
"type": "array",
"description": "Ephemeral volumes for the service.",
"constraints": {
"constraintType": "array",
"category": "discovery",
"maxItems": 16,
"deterministic": true,
"metadata": {
"source": "discovery",
"confidence": 0.99,
"validatedAt": "2026-08-20T09:12:47+00:00"
}
},
"required_for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
}
}
},
"oneOfVariants": {
"spec.workload_choice": [
"job",
"service",
"simple_service",
"stateful_service"
],
"spec.job.deploy_options.deploy_choice": [
"all_res",
"default_virtual_sites",
"deploy_ce_sites",
"deploy_ce_virtual_sites",
"deploy_re_sites",
"deploy_re_virtual_sites"
],
"spec.service.scaling_choice": [
"num_replicas",
"scale_to_zero"
],
"spec.service.advertise_options.advertise_choice": [
"advertise_custom",
"advertise_in_cluster",
"advertise_on_public",
"do_not_advertise"
],
"spec.service.deploy_options.deploy_choice": [
"all_res",
"default_virtual_sites",
"deploy_ce_sites",
"deploy_ce_virtual_sites",
"deploy_re_sites",
"deploy_re_virtual_sites"
],
"spec.simple_service.advertise_choice": [
"do_not_advertise",
"simple_advertise"
],
"spec.simple_service.persistence_choice": [
"disabled",
"enabled"
],
"spec.simple_service.container.flavor_choice": [
"custom_flavor",
"default_flavor",
"flavor"
],
"spec.stateful_service.scaling_choice": [
"num_replicas",
"scale_to_zero"
],
"spec.stateful_service.advertise_options.advertise_choice": [
"advertise_custom",
"advertise_in_cluster",
"advertise_on_public",
"do_not_advertise"
],
"spec.stateful_service.deploy_options.deploy_choice": [
"all_res",
"default_virtual_sites",
"deploy_ce_sites",
"deploy_ce_virtual_sites",
"deploy_re_sites",
"deploy_re_virtual_sites"
]
}
},
{
"name": "list_workloads",
"description": "List Workload.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/workloads",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "label_filter",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "report_fields",
"in": "query",
"required": false,
"type": "array"
},
{
"name": "report_status_fields",
"in": "query",
"required": false,
"type": "array"
}
],
"responseSchema": {
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"items": {
"type": "array"
}
}
},
"responseSummary": [
{
"field": "errors",
"type": "array",
"description": "Errors(if any) while listing items from collection."
},
{
"field": "items",
"type": "array",
"description": "Items represents the collection in response."
}
]
},
{
"name": "delete_workload",
"description": "DELETE Workload.",
"method": "DELETE",
"path": "/api/config/namespaces/{namespace}/workloads/{name}",
      "dangerLevel": "high",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"bodySchema": {
"type": "object",
"description": "This is the input message of the 'DELETE' RPC.",
"title": "DeleteRequest is used to delete a workload",
"x-displayname": "DELETE Request.",
"x-ves-proto-message": "ves.io.schema.views.workload.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",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
},
"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.",
"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-08-20T09:12:47+00:00"
},
"deterministic": true
},
"x-f5xc-required-for": {
"minimum_config": false,
"create": false,
"update": false,
"read": false
},
"x-reconciled-from-discovery": true,
"x-reconciled-at": "2026-08-20T09:12:47+00:00"
}
},
"x-f5xc-minimum-configuration": {
"description": "Minimum configuration for workloadDeleteRequest",
"required_fields": [],
"mutually_exclusive_groups": [],
"example_yaml": "# Minimal example for workloadDeleteRequest\nmetadata:\n  name: example\n  namespace: default\nspec: {}",
"example_json": "{\n  \"metadata\": {\n    \"name\": \"example\",\n    \"namespace\": \"default\"\n  },\n  \"spec\": {}\n}"
},
"x-f5xc-cli-domain": "container_services"
}
},
{
"name": "get_workload",
"description": "GET Workload.",
"method": "GET",
"path": "/api/config/namespaces/{namespace}/workloads/{name}",
      "dangerLevel": "low",
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string",
"default": "$F5XC_NAMESPACE"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "response_format",
"in": "query",
"required": false,
"type": "string"
}
],
"responseSchema": {
"type": "object",
"properties": {
"deleted_referred_objects": {
"type": "array"
},
"disabled_referred_objects": {
"type": "array"
},
"referring_objects": {
"type": "array"
},
"status": {
"type": "array"
},
"resource_version": {
"type": "string"
}
}
},
"responseSummary": [
{
"field": "create_form",
"type": "object",
"description": ""
},
{
"field": "deleted_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "disabled_referred_objects",
"type": "array",
"description": "The set of deleted objects that are referred by this object."
},
{
"field": "metadata",
"type": "object",
"description": ""
},
{
"field": "referring_objects",
"type": "array",
"description": "The set of objects that are referring to this object in their spec."
},
{
"field": "replace_form",
"type": "object",
"description": ""
},
{
"field": "spec",
"type": "object",
"description": ""
},
{
"field": "status",
"type": "array",
"description": "The status reported by different services for this configuration object."
},
{
"field": "system_metadata",
"type": "object",
"description": ""
},
{
"field": "resource_version",
"type": "string",
"description": ""
}
]
}
]
},
};